JHUAPL-DTNMA / dtnma-ace

The DTNMA AMM CODEC Engine (ACE)
https://jhuapl-dtnma.github.io/dtnma-ace/
Apache License 2.0
1 stars 0 forks source link

Update documentation #7

Open mfarina1 opened 1 month ago

mfarina1 commented 1 month ago

Update README and the generated API Python docs

mfarina1 commented 1 month ago

Potential updates to README:

mfarina1 commented 2 weeks ago
justinethier commented 1 week ago

Worked through installation of ACE this afternoon with @mfarina1 and we identified the following procedure to set everything up:

python3 -m venv .venv
source .venv/bin/activate
pip3 install pip-tools
python3 -m piptools compile --extra test pyproject.toml
pip3 install -r requirements.txt 
pip3 install -e '.[test]'
python3 -m pytest -v --cov=ace tests

This was tested on Ubuntu 22 with Python 3.10.

justinethier commented 6 days ago

Also, these commands are useful to run individual unit tests and may be worth documenting for development:

pytest -v -o log_cli=true tests/test_ari_text.py
pytest -v --log-cli-level=INFO tests/test_ari_text.py -k 'test_literal_text_options'