aind-dynamic-foraging-models 0.0.1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- aind_dynamic_foraging_models/__init__.py +2 -0
- aind_dynamic_foraging_models-0.0.1.dist-info/LICENSE +21 -0
- aind_dynamic_foraging_models-0.0.1.dist-info/METADATA +119 -0
- aind_dynamic_foraging_models-0.0.1.dist-info/RECORD +6 -0
- aind_dynamic_foraging_models-0.0.1.dist-info/WHEEL +5 -0
- aind_dynamic_foraging_models-0.0.1.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2022 Allen Institute for Neural Dynamics
|
|
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.
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: aind-dynamic-foraging-models
|
|
3
|
+
Version: 0.0.1
|
|
4
|
+
Summary: Generated from aind-library-template
|
|
5
|
+
Author: Allen Institute for Neural Dynamics
|
|
6
|
+
License: MIT
|
|
7
|
+
Classifier: Programming Language :: Python :: 3
|
|
8
|
+
Requires-Python: >=3.7
|
|
9
|
+
Description-Content-Type: text/markdown
|
|
10
|
+
License-File: LICENSE
|
|
11
|
+
Provides-Extra: dev
|
|
12
|
+
Requires-Dist: black ; extra == 'dev'
|
|
13
|
+
Requires-Dist: coverage ; extra == 'dev'
|
|
14
|
+
Requires-Dist: flake8 ; extra == 'dev'
|
|
15
|
+
Requires-Dist: interrogate ; extra == 'dev'
|
|
16
|
+
Requires-Dist: isort ; extra == 'dev'
|
|
17
|
+
Requires-Dist: Sphinx ; extra == 'dev'
|
|
18
|
+
Requires-Dist: furo ; extra == 'dev'
|
|
19
|
+
|
|
20
|
+
# aind-dynamic-foraging-models
|
|
21
|
+
|
|
22
|
+
[](LICENSE)
|
|
23
|
+
|
|
24
|
+
[](https://github.com/semantic-release/semantic-release)
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
## Usage
|
|
32
|
+
- To use this template, click the green `Use this template` button and `Create new repository`.
|
|
33
|
+
- After github initially creates the new repository, please wait an extra minute for the initialization scripts to finish organizing the repo.
|
|
34
|
+
- To enable the automatic semantic version increments: in the repository go to `Settings` and `Collaborators and teams`. Click the green `Add people` button. Add `svc-aindscicomp` as an admin. Modify the file in `.github/workflows/tag_and_publish.yml` and remove the if statement in line 10. The semantic version will now be incremented every time a code is committed into the main branch.
|
|
35
|
+
- To publish to PyPI, enable semantic versioning and uncomment the publish block in `.github/workflows/tag_and_publish.yml`. The code will now be published to PyPI every time the code is committed into the main branch.
|
|
36
|
+
- The `.github/workflows/test_and_lint.yml` file will run automated tests and style checks every time a Pull Request is opened. If the checks are undesired, the `test_and_lint.yml` can be deleted. The strictness of the code coverage level, etc., can be modified by altering the configurations in the `pyproject.toml` file and the `.flake8` file.
|
|
37
|
+
|
|
38
|
+
## Installation
|
|
39
|
+
To use the software, in the root directory, run
|
|
40
|
+
```bash
|
|
41
|
+
pip install -e .
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
To develop the code, run
|
|
45
|
+
```bash
|
|
46
|
+
pip install -e .[dev]
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## Contributing
|
|
50
|
+
|
|
51
|
+
### Linters and testing
|
|
52
|
+
|
|
53
|
+
There are several libraries used to run linters, check documentation, and run tests.
|
|
54
|
+
|
|
55
|
+
- Please test your changes using the **coverage** library, which will run the tests and log a coverage report:
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
coverage run -m unittest discover && coverage report
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
- Use **interrogate** to check that modules, methods, etc. have been documented thoroughly:
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
interrogate .
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
- Use **flake8** to check that code is up to standards (no unused imports, etc.):
|
|
68
|
+
```bash
|
|
69
|
+
flake8 .
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
- Use **black** to automatically format the code into PEP standards:
|
|
73
|
+
```bash
|
|
74
|
+
black .
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
- Use **isort** to automatically sort import statements:
|
|
78
|
+
```bash
|
|
79
|
+
isort .
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### Pull requests
|
|
83
|
+
|
|
84
|
+
For internal members, please create a branch. For external members, please fork the repository and open a pull request from the fork. We'll primarily use [Angular](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit) style for commit messages. Roughly, they should follow the pattern:
|
|
85
|
+
```text
|
|
86
|
+
<type>(<scope>): <short summary>
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
where scope (optional) describes the packages affected by the code changes and type (mandatory) is one of:
|
|
90
|
+
|
|
91
|
+
- **build**: Changes that affect build tools or external dependencies (example scopes: pyproject.toml, setup.py)
|
|
92
|
+
- **ci**: Changes to our CI configuration files and scripts (examples: .github/workflows/ci.yml)
|
|
93
|
+
- **docs**: Documentation only changes
|
|
94
|
+
- **feat**: A new feature
|
|
95
|
+
- **fix**: A bugfix
|
|
96
|
+
- **perf**: A code change that improves performance
|
|
97
|
+
- **refactor**: A code change that neither fixes a bug nor adds a feature
|
|
98
|
+
- **test**: Adding missing tests or correcting existing tests
|
|
99
|
+
|
|
100
|
+
### Semantic Release
|
|
101
|
+
|
|
102
|
+
The table below, from [semantic release](https://github.com/semantic-release/semantic-release), shows which commit message gets you which release type when `semantic-release` runs (using the default configuration):
|
|
103
|
+
|
|
104
|
+
| Commit message | Release type |
|
|
105
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------- |
|
|
106
|
+
| `fix(pencil): stop graphite breaking when too much pressure applied` | ~~Patch~~ Fix Release, Default release |
|
|
107
|
+
| `feat(pencil): add 'graphiteWidth' option` | ~~Minor~~ Feature Release |
|
|
108
|
+
| `perf(pencil): remove graphiteWidth option`<br><br>`BREAKING CHANGE: The graphiteWidth option has been removed.`<br>`The default graphite width of 10mm is always used for performance reasons.` | ~~Major~~ Breaking Release <br /> (Note that the `BREAKING CHANGE: ` token must be in the footer of the commit) |
|
|
109
|
+
|
|
110
|
+
### Documentation
|
|
111
|
+
To generate the rst files source files for documentation, run
|
|
112
|
+
```bash
|
|
113
|
+
sphinx-apidoc -o doc_template/source/ src
|
|
114
|
+
```
|
|
115
|
+
Then to create the documentation HTML files, run
|
|
116
|
+
```bash
|
|
117
|
+
sphinx-build -b html doc_template/source/ doc_template/build/html
|
|
118
|
+
```
|
|
119
|
+
More info on sphinx installation can be found [here](https://www.sphinx-doc.org/en/master/usage/installation.html).
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
aind_dynamic_foraging_models/__init__.py,sha256=_b3QC6Y7NboP73RjV4irH9taFd2HaRADfzFUkRDgcbk,41
|
|
2
|
+
aind_dynamic_foraging_models-0.0.1.dist-info/LICENSE,sha256=U0Y7B3gZJHXpjJVLgTQjM8e_c8w4JJpLgGhIdsoFR1Y,1092
|
|
3
|
+
aind_dynamic_foraging_models-0.0.1.dist-info/METADATA,sha256=IgpKx8NWKNvCjSfqHC78NeO7Dc_GX9583J-U0Nhh17g,6377
|
|
4
|
+
aind_dynamic_foraging_models-0.0.1.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
|
|
5
|
+
aind_dynamic_foraging_models-0.0.1.dist-info/top_level.txt,sha256=YN5-qw5Mb-0L3QKEe8FK-4QjBpd_bBW_cGNgcfGtvX8,29
|
|
6
|
+
aind_dynamic_foraging_models-0.0.1.dist-info/RECORD,,
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
aind_dynamic_foraging_models
|