Skip to content

Commit 27f6c29

Browse files
Demoren1Demoren1
authored
Initial commit
0 parents  commit 27f6c29

24 files changed

+3580
-0
lines changed

‎.github/workflows/docs.yaml

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: docs
2+
3+
on:
4+
push:
5+
branches: [ master ]
6+
pull_request:
7+
branches: [ master ]
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
13+
strategy:
14+
matrix:
15+
python-version: [3.7]
16+
17+
steps:
18+
- name: Set up Python
19+
uses: actions/setup-python@v1
20+
with:
21+
python-version: 3.7
22+
23+
- name: Checkout 🛎️
24+
uses: actions/checkout@v2
25+
26+
- name: Install Dependencies
27+
run: |
28+
pip install -U sphinx
29+
pip install -U sphinx-rtd-theme
30+
31+
- name: Build Docs
32+
run: |
33+
sphinx-build -b html ./doc/source/ public
34+
touch public/.nojekyll
35+
36+
- name: Deploy 🚀
37+
uses: JamesIves/github-pages-deploy-action@releases/v3
38+
with:
39+
ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
40+
BRANCH: gh-pages
41+
FOLDER: public

‎.github/workflows/test.yml

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: test
2+
on: [push, pull_request, workflow_dispatch]
3+
4+
jobs:
5+
pytest:
6+
name: pytest
7+
runs-on: ubuntu-latest
8+
9+
strategy:
10+
matrix:
11+
python-version: [3.7]
12+
13+
steps:
14+
- name: Set up Python
15+
uses: actions/setup-python@v1
16+
with:
17+
python-version: 3.7
18+
19+
- name: Checkout 🛎️
20+
uses: actions/checkout@v2
21+
22+
- name: Install Dependencies
23+
run: |
24+
pip install -U pytest pytest-cov
25+
pip install -U -r src/requirements.txt
26+
27+
- name: Testing
28+
run: |
29+
PYTHONPATH=src/ pytest tests/ --cov=mylib --cov-report=xml
30+
31+
- name: Upload to Codecov
32+
uses: codecov/codecov-action@v2
33+
with:
34+
files: ./coverage.xml,
35+
fail_ci_if_error: true
36+
verbose: true

‎.gitignore

+122
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
public/
13+
develop-eggs/
14+
dist/
15+
downloads/
16+
eggs/
17+
.eggs/
18+
lib/
19+
lib64/
20+
parts/
21+
sdist/
22+
var/
23+
wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
MANIFEST
28+
*.bin
29+
30+
# PyInstaller
31+
# Usually these files are written by a python script from a template
32+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
33+
*.manifest
34+
*.spec
35+
36+
# Installer logs
37+
pip-log.txt
38+
pip-delete-this-directory.txt
39+
40+
# Unit test / coverage reports
41+
htmlcov/
42+
.tox/
43+
.coverage
44+
.coverage.*
45+
.cache
46+
nosetests.xml
47+
coverage.xml
48+
*.cover
49+
.hypothesis/
50+
.pytest_cache/
51+
52+
# Translations
53+
*.mo
54+
*.pot
55+
56+
# Django stuff:
57+
*.log
58+
local_settings.py
59+
db.sqlite3
60+
61+
# Flask stuff:
62+
instance/
63+
.webassets-cache
64+
65+
# Scrapy stuff:
66+
.scrapy
67+
68+
# Sphinx documentation
69+
docs/_build/
70+
71+
# PyBuilder
72+
target/
73+
74+
# Jupyter Notebook
75+
.ipynb_checkpoints
76+
77+
# pyenv
78+
.python-version
79+
80+
# celery beat schedule file
81+
celerybeat-schedule
82+
83+
# SageMath parsed files
84+
*.sage.py
85+
86+
# Environments
87+
.env
88+
.venv
89+
env/
90+
venv/
91+
ENV/
92+
env.bak/
93+
venv.bak/
94+
95+
# Spyder project settings
96+
.spyderproject
97+
.spyproject
98+
99+
# Rope project settings
100+
.ropeproject
101+
102+
# mkdocs documentation
103+
/site
104+
105+
# mypy
106+
.mypy_cache/
107+
108+
# Exclude __pycache__ :
109+
__pycache__/
110+
# Exclude .gitignore:
111+
.gitignore
112+
# Exclude folders with name logs:
113+
logs/
114+
115+
# Exclude all .dat files:
116+
*.dat
117+
# Exclude all files which begin on .
118+
*/.*
119+
.*
120+
*/mnist
121+
*.csv
122+
!.dvc

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 Intelligent Systems, Phystech.edu
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.rst

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
|test| |codecov| |docs|
2+
3+
.. |test| image:: https://github.com/intsystems/ProjectTemplate/workflows/test/badge.svg
4+
:target: https://github.com/intsystems/ProjectTemplate/tree/master
5+
:alt: Test status
6+
7+
.. |codecov| image:: https://img.shields.io/codecov/c/github/intsystems/ProjectTemplate/master
8+
:target: https://app.codecov.io/gh/intsystems/ProjectTemplate
9+
:alt: Test coverage
10+
11+
.. |docs| image:: https://github.com/intsystems/ProjectTemplate/workflows/docs/badge.svg
12+
:target: https://intsystems.github.io/ProjectTemplate/
13+
:alt: Docs status
14+
15+
16+
.. class:: center
17+
18+
:Название исследуемой задачи: Мое название работы
19+
:Тип научной работы: M1P/НИР/CoIS
20+
:Автор: Имя Отчество Фамилия
21+
:Научный руководитель: степень, Фамилия Имя Отчество
22+
:Научный консультант(при наличии): степень, Фамилия Имя Отчество
23+
24+
Abstract
25+
========
26+
27+
Purus sit amet luctus venenatis lectus magna fringilla. Condimentum id venenatis a condimentum vitae sapien. Auctor neque vitae tempus quam pellentesque nec nam aliquam. Eget egestas purus viverra accumsan in. Nam aliquam sem et tortor. Donec et odio pellentesque diam volutpat commodo. Odio pellentesque diam volutpat commodo sed egestas. Sit amet dictum sit amet justo. Pellentesque sit amet porttitor eget. Imperdiet sed euismod nisi porta lorem mollis aliquam ut. Quis varius quam quisque id diam vel quam elementum. Ornare lectus sit amet est placerat in. Vulputate dignissim suspendisse in est ante. Elit sed vulputate mi sit amet mauris. Egestas sed tempus urna et pharetra pharetra. Viverra tellus in hac habitasse platea dictumst vestibulum rhoncus.
28+
29+
Research publications
30+
===============================
31+
1.
32+
33+
Presentations at conferences on the topic of research
34+
================================================
35+
1.
36+
37+
Software modules developed as part of the study
38+
======================================================
39+
1. A python package *mylib* with all implementation `here <https://github.com/intsystems/ProjectTemplate/tree/master/src>`_.
40+
2. A code with all experiment visualisation `here <https://github.comintsystems/ProjectTemplate/blob/master/code/main.ipynb>`_. Can use `colab <http://colab.research.google.com/github/intsystems/ProjectTemplate/blob/master/code/main.ipynb>`_.

0 commit comments

Comments
 (0)