Skip to content

Commit cc2c61b

Browse files
timmenstimmens
committed
Initial commit
0 parents  commit cc2c61b

21 files changed

+691
-0
lines changed

‎.gitignore

+161
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,161 @@
1+
# misc
2+
.DS_Store
3+
4+
# bld
5+
bld/*
6+
7+
# Byte-compiled / optimized / DLL files
8+
__pycache__/
9+
*.py[cod]
10+
*$py.class
11+
12+
# C extensions
13+
*.so
14+
15+
# Distribution / packaging
16+
.Python
17+
build/
18+
develop-eggs/
19+
dist/
20+
downloads/
21+
eggs/
22+
.eggs/
23+
lib/
24+
lib64/
25+
parts/
26+
sdist/
27+
var/
28+
wheels/
29+
pip-wheel-metadata/
30+
share/python-wheels/
31+
*.egg-info/
32+
.installed.cfg
33+
*.egg
34+
MANIFEST
35+
36+
# PyInstaller
37+
# Usually these files are written by a python script from a template
38+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
39+
*.manifest
40+
*.spec
41+
42+
# Installer logs
43+
pip-log.txt
44+
pip-delete-this-directory.txt
45+
46+
# Unit test / coverage reports
47+
htmlcov/
48+
.tox/
49+
.nox/
50+
.coverage
51+
.coverage.*
52+
.cache
53+
nosetests.xml
54+
coverage.xml
55+
*.cover
56+
*.py,cover
57+
.hypothesis/
58+
.pytest_cache/
59+
60+
# Translations
61+
*.mo
62+
*.pot
63+
64+
# Django stuff:
65+
*.log
66+
local_settings.py
67+
db.sqlite3
68+
db.sqlite3-journal
69+
70+
# Flask stuff:
71+
instance/
72+
.webassets-cache
73+
74+
# Scrapy stuff:
75+
.scrapy
76+
77+
# Sphinx documentation
78+
docs/build/
79+
80+
# PyBuilder
81+
target/
82+
83+
# Jupyter Notebook
84+
.ipynb_checkpoints
85+
notebooks/
86+
87+
# IPython
88+
profile_default/
89+
ipython_config.py
90+
91+
# pyenv
92+
.python-version
93+
94+
# pipenv
95+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
96+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
97+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
98+
# install all needed dependencies.
99+
#Pipfile.lock
100+
101+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
102+
__pypackages__/
103+
104+
# Celery stuff
105+
celerybeat-schedule
106+
celerybeat.pid
107+
108+
# SageMath parsed files
109+
*.sage.py
110+
111+
# Environments
112+
.env
113+
.venv
114+
env/
115+
venv/
116+
ENV/
117+
env.bak/
118+
venv.bak/
119+
120+
# Spyder project settings
121+
.spyderproject
122+
.spyproject
123+
124+
# Rope project settings
125+
.ropeproject
126+
127+
# mkdocs documentation
128+
/site
129+
130+
# mypy
131+
.mypy_cache/
132+
.dmypy.json
133+
dmypy.json
134+
135+
# Pyre type checker
136+
.pyre/
137+
138+
# Files
139+
.coverage
140+
coverage.*
141+
142+
# Folders
143+
.idea
144+
.ipynb_checkpoints
145+
.tox
146+
.vscode
147+
_build
148+
__pycache__
149+
_generated
150+
151+
*.egg-info
152+
.eggs
153+
154+
.pytask.sqlite3
155+
156+
build
157+
dist
158+
159+
.pytask
160+
_version.py
161+
pdfs

‎.pre-commit-config.yaml

+99
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
repos:
2+
- repo: https://github.com/pre-commit/pre-commit-hooks
3+
rev: v4.2.0
4+
hooks:
5+
- id: check-added-large-files
6+
args: ["--maxkb=1000"]
7+
- id: check-case-conflict
8+
- id: check-merge-conflict
9+
- id: check-vcs-permalinks
10+
- id: check-yaml
11+
- id: debug-statements
12+
- id: end-of-file-fixer
13+
- id: fix-byte-order-marker
14+
- id: mixed-line-ending
15+
- id: trailing-whitespace
16+
- repo: https://github.com/pre-commit/pygrep-hooks
17+
rev: v1.9.0
18+
hooks:
19+
- id: python-check-blanket-noqa
20+
- id: python-check-mock-methods
21+
- id: python-no-eval
22+
- id: python-no-log-warn
23+
- id: python-use-type-annotations
24+
- id: text-unicode-replacement-char
25+
- repo: https://github.com/asottile/pyupgrade
26+
rev: v2.32.0
27+
hooks:
28+
- id: pyupgrade
29+
args: [--py37-plus]
30+
- repo: https://github.com/asottile/reorder_python_imports
31+
rev: v3.0.1
32+
hooks:
33+
- id: reorder-python-imports
34+
- repo: https://github.com/asottile/setup-cfg-fmt
35+
rev: v1.20.0
36+
hooks:
37+
- id: setup-cfg-fmt
38+
- repo: https://github.com/psf/black
39+
rev: 22.3.0
40+
hooks:
41+
- id: black
42+
- repo: https://github.com/PyCQA/flake8
43+
rev: 4.0.1
44+
hooks:
45+
- id: flake8
46+
additional_dependencies: [
47+
flake8-alfred,
48+
flake8-bugbear,
49+
flake8-builtins,
50+
flake8-comprehensions,
51+
flake8-docstrings,
52+
flake8-eradicate,
53+
flake8-print,
54+
flake8-pytest-style,
55+
flake8-todo,
56+
flake8-typing-imports,
57+
flake8-unused-arguments,
58+
pep8-naming,
59+
pydocstyle,
60+
Pygments,
61+
]
62+
args: [--ignore, "N806, D404, D100, D103"]
63+
- repo: https://github.com/guilatrova/tryceratops
64+
rev: v1.0.1
65+
hooks:
66+
- id: tryceratops
67+
- repo: https://github.com/codespell-project/codespell
68+
rev: v2.1.0
69+
hooks:
70+
- id: codespell
71+
args: [--skip, "*.html,*ipynb,*.bib,paper/"]
72+
- repo: https://github.com/executablebooks/mdformat
73+
rev: 0.7.14
74+
hooks:
75+
- id: mdformat
76+
additional_dependencies: [
77+
mdformat-gfm,
78+
mdformat-black,
79+
]
80+
args: [--wrap, "88"]
81+
files: (README.md)
82+
- repo: https://github.com/executablebooks/mdformat
83+
rev: 0.7.14
84+
hooks:
85+
- id: mdformat
86+
additional_dependencies: [
87+
mdformat-myst,
88+
mdformat-black,
89+
]
90+
args: [--wrap, "88"]
91+
files: (docs/.)
92+
# Exclude files with admonitions.
93+
# exclude: |
94+
# (?x)^(
95+
# path/to/file.py
96+
# )$
97+
- repo: meta
98+
hooks:
99+
- id: check-useless-excludes

‎LICENSE

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

‎README.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Tranquilo Development Repository
2+
3+
## Getting Started
4+
5+
Get started by installing the conda environment.
6+
7+
```bash
8+
cd /path/to/project_root
9+
conda env create -f environment.yml
10+
conda activate tranquilo_dev
11+
```
12+
13+
## Presentation
14+
15+
Our presentation is compiled to HTML using [marp](https://marp.app/), which needs to be
16+
installed and made available to the PATH.
17+
18+
**Installation:**
19+
20+
- marp: Can be installed from the
21+
[README instructions](https://github.com/marp-team/marp-cli)
22+
23+
**Rendering:**
24+
25+
When running `pytask` marp is automatically executed with the correct flags. For the
26+
development process it is, however, easier to run marp directly. In this case, change
27+
into the directory where the markdown file you want to render is stored. Then run
28+
29+
```bash
30+
marp --html --watch --theme-set custom.scss -- main.md
31+
```
32+
33+
Now you can edit the markdown file while the rendered HTML version is continuously
34+
updated (view it in a browser).
35+
36+
## Credits
37+
38+
This project was created with [cookiecutter](https://github.com/audreyr/cookiecutter)
39+
and the
40+
[cookiecutter-pytask-project](https://github.com/pytask-dev/cookiecutter-pytask-project)
41+
template.

‎environment.yml

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: tranquilo_dev
2+
3+
channels:
4+
- conda-forge
5+
- nodefaults
6+
7+
dependencies:
8+
- python ==3.9
9+
- pip
10+
11+
# Dependencies
12+
- pandas
13+
- numpy
14+
- scipy
15+
- jupyterlab
16+
- ipython
17+
- seaborn
18+
- estimagic >=0.4.0
19+
20+
# Misc Start
21+
- setuptools_scm
22+
- toml
23+
- pytask >=0.2.3
24+
- black
25+
- nb_black
26+
- pre-commit
27+
- pdbpp
28+
- pytest
29+
- pytest-cov
30+
- pytest-xdist
31+
- tox-conda
32+
- conda-lock
33+
# Misc End
34+
35+
- pip:
36+
- black
37+
- blackcellmagic
38+
- kaleido
39+
40+
# Install project
41+
- -e .

‎pyproject.toml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
[build-system]
2+
requires = ["setuptools>=45", "wheel", "setuptools_scm[toml]>=6.0"]
3+
4+
5+
[tool.setuptools_scm]
6+
write_to = "src/tranquilo_dev/_version.py"
7+
8+
[tool.pytask.ini_options]
9+
paths = "./src/tranquilo_dev"
10+
11+
[tool.interrogate]
12+
ignore-init-module = true
13+
ignore-nested-functions = true
14+
exclude = ["setup.py", "docs", "bld"]
15+
ignore-regex = ["task_*"]

0 commit comments

Comments
 (0)