Skip to content

Commit

Permalink
Add Disclaimer
Browse files Browse the repository at this point in the history
  • Loading branch information
Bridenbecker committed Sep 28, 2024
1 parent 1a70286 commit 86ae580
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

# emodpy

*STILL IN DEVELOPEMENT*

## Documentation

Documentation available at https://docs.idmod.org/projects/emodpy/en/latest/.
Expand Down Expand Up @@ -106,3 +104,10 @@ pip install idmtools-test --index-url=https://packages.idmod.org/api/pypi/pypi-p
## Building docs

Install all necessary documentation tools using ``pip install -r doc/requirements.txt`` and install emodpy in the same environment. Navigate to the docs folder and enter ``make html``. If you make updates to the docstrings, you must reinstall emodpy to pick up the latest changes in the documentation build. It's also good practice to run ``make clean`` before rebuilding the documentation to avoid missing errors or warnings. These steps are only for testing the build locally before committing changes. The documentation build on Read the Docs will run automatically when new code is committed.

### Disclaimer

The code in this repository was developed by IDM and other collaborators to support our joint research on flexible agent-based modeling.
We've made it publicly available under the MIT License to provide others with a better understanding of our research and an opportunity to build upon it for
their own work. We make no representations that the code works as intended or that we will provide support, address issues that are found, or accept pull requests.
You are welcome to create your own fork and modify the code to suit your own modeling needs as permitted under the MIT License.

0 comments on commit 86ae580

Please sign in to comment.