Initial commit

.github/workflows/docs.yaml

@@ -0,0 +1,41 @@
+name: docs
+
+on:
+ push:
+ branches: [ master ]
+ pull_request:
+ branches: [ master ]
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+
+ strategy:
+ matrix:
+ python-version: [3.7]
+
+ steps:
+ - name: Set up Python
+ uses: actions/setup-python@v1
+ with:
+ python-version: 3.7
+
+ - name: Checkout 🛎️
+ uses: actions/checkout@v2
+
+ - name: Install Dependencies
+ run: |
+ pip install -U sphinx
+ pip install -U sphinx-rtd-theme
+ 
+ - name: Build Docs
+ run: |
+ sphinx-build -b html ./doc/source/ public
+ touch public/.nojekyll
+ 
+ - name: Deploy 🚀
+ uses: JamesIves/github-pages-deploy-action@releases/v3
+ with:
+ ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
+ BRANCH: gh-pages
+ FOLDER: public

.github/workflows/test.yml

@@ -0,0 +1,36 @@
+name: test
+on: [push, pull_request]
+
+jobs:
+ pytest:
+ name: pytest
+ runs-on: ubuntu-latest
+
+ strategy:
+ matrix:
+ python-version: [3.7]
+
+ steps:
+ - name: Set up Python
+ uses: actions/setup-python@v1
+ with:
+ python-version: 3.7
+
+ - name: Checkout 🛎️
+ uses: actions/checkout@v2
+
+ - name: Install Dependencies
+ run: |
+ pip install -U pytest pytest-cov
+ pip install -U -r src/requirements.txt
+ 
+ - name: Testing
+ run: |
+ PYTHONPATH=src/ pytest tests/ --cov=mylib --cov-report=xml
+ 
+ - name: Upload to Codecov
+ uses: codecov/codecov-action@v2
+ with:
+ files: ./coverage.xml,
+ fail_ci_if_error: true
+ verbose: true

.gitignore

@@ -0,0 +1,122 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+public/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+*.bin
+
+# PyInstaller
+# Usually these files are written by a python script from a template
+# before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# Exclude __pycache__ :
+__pycache__/
+# Exclude .gitignore:
+.gitignore
+# Exclude folders with name logs:
+logs/
+
+# Exclude all .dat files:
+*.dat
+# Exclude all files which begin on .
+*/.*
+.*
+*/mnist
+*.csv
+!.dvc

LICENSE

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

README.rst

@@ -0,0 +1,40 @@
+|test| |codecov| |docs|
+
+.. |test| image:: https://github.com/intsystems/ProjectTemplate/workflows/test/badge.svg
+ :target: https://github.com/intsystems/ProjectTemplate/tree/master
+ :alt: Test status
+
+.. |codecov| image:: https://img.shields.io/codecov/c/github/intsystems/ProjectTemplate/master
+ :target: https://app.codecov.io/gh/intsystems/ProjectTemplate
+ :alt: Test coverage
+
+.. |docs| image:: https://github.com/intsystems/ProjectTemplate/workflows/docs/badge.svg
+ :target: https://intsystems.github.io/ProjectTemplate/
+ :alt: Docs status
+
+
+.. class:: center
+
+ :Название исследуемой задачи: Мое название работы
+ :Тип научной работы: M1P/НИР/CoIS
+ :Автор: Имя Отчество Фамилия
+ :Научный руководитель: степень, Фамилия Имя Отчество
+ :Научный консультант(при наличии): степень, Фамилия Имя Отчество
+
+Abstract
+========
+
+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.
+
+Research publications
+===============================
+1. 
+
+Presentations at conferences on the topic of research
+================================================
+1. 
+
+Software modules developed as part of the study
+======================================================
+1. A python package *mylib* with all implementation `here <https://github.com/intsystems/ProjectTemplate/tree/master/src>`_.
+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>`_.