Skip to content

Commit 6d20f3e

Browse files
timmenstimmens
committed
Initial commit
0 parents  commit 6d20f3e

19 files changed

+711
-0
lines changed

‎.envs/testenv.yml

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: lcm-dev
3+
channels:
4+
- conda-forge
5+
- nodefaults
6+
dependencies:
7+
- pip
8+
- setuptools_scm
9+
- toml
10+
11+
# Package dependencies
12+
- estimagic
13+
- numpy
14+
- scipy
15+
- pandas
16+
- jax>=0.3.0
17+
- jaxlib>=0.3.0
18+
- networkx
19+
- dags
20+
- pybaum
21+
22+
# Misc
23+
- pytest
24+
- pytest-cov
25+
- pytest-xdist
26+
- sphinx
27+
- sphinx-panels
28+
- sphinxcontrib-bibtex
29+
- pydata-sphinx-theme>=0.3.0
30+
- pip:
31+
- -e ../

‎.github/ISSUE_TEMPLATE/bug_report.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Bug Report
3+
about: Create a bug report to help us improve lcm-dev
4+
title: "BUG:"
5+
labels: "bug"
6+
---
7+
8+
- [ ] I have checked that this issue has not already been reported.
9+
10+
- [ ] I have confirmed this bug exists on the latest version of lcm-dev.
11+
12+
- [ ] (optional) I have confirmed this bug exists on the `main` branch of lcm-dev.
13+
14+
---
15+
16+
**Note**: Please read [this
17+
guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing
18+
how to provide the necessary information for us to reproduce your bug.
19+
20+
#### Code Sample, a copy-pastable example
21+
22+
```python
23+
# Your code here
24+
```
25+
26+
#### Problem description
27+
28+
Explain **why** the current behaviour is a problem and why the expected output is a
29+
better solution.
30+
31+
#### Expected Output

‎.github/ISSUE_TEMPLATE/enhancement.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Enhancement
3+
about: Suggest an idea for lcm-dev
4+
title: "ENH:"
5+
labels: "enhancement"
6+
---
7+
8+
#### Is your feature request related to a problem?
9+
10+
Provide a description of what the problem is, e.g. "I wish I could use lcm-dev to do
11+
[...]".
12+
13+
#### Describe the solution you'd like
14+
15+
Provide a description of the feature request and how it might be implemented.
16+
17+
#### API breaking implications
18+
19+
Provide a description of how this feature will affect the API.
20+
21+
#### Describe alternatives you've considered
22+
23+
Provide a description of any alternative solutions or features you've considered.
24+
25+
#### Additional context
26+
27+
Add any other context, code examples, or references to existing implementations about
28+
the feature request here.
29+
30+
```python
31+
# Your code here, if applicable
32+
```

‎.github/ISSUE_TEMPLATE/question.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: Submit Question
3+
about: Ask a general question about lcm-dev
4+
title: "QST:"
5+
labels: "question"
6+
---
7+
8+
#### Question about lcm-dev
9+
10+
**Note**: If you'd still like to submit a question, please read [this guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing how to
11+
provide the necessary information for us to reproduce your question.
12+
13+
```python
14+
# Your code here, if applicable
15+
```

‎.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
### What problem do you want to solve?
2+
3+
Reference the issue or discussion, if there is any. Provide a description of your
4+
proposed solution.
5+
6+
### Todo
7+
8+
- [ ] Target the right branch and pick an appropriate title.
9+
- [ ] Put `Closes #XXXX` in the first PR comment to auto-close the relevant issue once
10+
the PR is accepted. This is not applicable if there is no corresponding issue.
11+
- [ ] Any steps that still need to be done.

‎.github/workflows/main.yml

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: main
3+
# Automatically cancel a previous run.
4+
concurrency:
5+
group: ${{ github.head_ref || github.run_id }}
6+
cancel-in-progress: true
7+
on:
8+
push:
9+
branches:
10+
- main
11+
pull_request:
12+
branches:
13+
- '*'
14+
jobs:
15+
run-tests:
16+
name: Run tests for ${{ matrix.os }} on ${{ matrix.python-version }}
17+
runs-on: ${{ matrix.os }}
18+
strategy:
19+
fail-fast: false
20+
matrix:
21+
os:
22+
- ubuntu-latest
23+
- macos-latest
24+
python-version:
25+
- '3.10'
26+
- '3.11'
27+
steps:
28+
- uses: actions/checkout@v3
29+
- name: create build environment
30+
uses: mamba-org/provision-with-micromamba@main
31+
with:
32+
environment-file: ./.envs/testenv.yml
33+
environment-name: lcm-dev
34+
cache-env: true
35+
extra-specs: |
36+
python=${{ matrix.python-version }}
37+
- name: run pytest
38+
shell: bash -l {0}
39+
run: |
40+
micromamba activate lcm-dev
41+
pytest --cov-report=xml --cov=./
42+
- name: Upload coverage report.
43+
if: runner.os == 'Linux' && matrix.python-version == '3.10'
44+
uses: codecov/codecov-action@v3
45+
with:
46+
token: ${{ secrets.CODECOV_TOKEN }}

‎.gitignore

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

0 commit comments

Comments
 (0)