Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update documentation #11

Open
mfarina1 opened this issue Sep 26, 2024 · 1 comment
Open

Update documentation #11

mfarina1 opened this issue Sep 26, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation
Milestone
CAMP v3.0.0

Comments

@mfarina1
Copy link
Collaborator

Update README and the generated API Python docs
@mfarina1 mfarina1 added the documentation Improvements or additions to documentation label Sep 26, 2024
@mfarina1 mfarina1 added this to the CAMP v3.0.0 milestone Sep 26, 2024
@mfarina1
Copy link
Collaborator Author

mfarina1 commented Oct 7, 2024 •
edited
Loading

Potential updates to README:

  • Changing all instances of CAmp to CAMP
  • Mention that one should build ACE before running CAMP
  • Include mention of preferred OS being RHEL 8
  • include command: git submodule update --init --recursive for resolving certain installation errors before running ./prep.sh script
  • Add instructions for working in Python virtual environment with proper version of python
  • Suggest running pip3 install command as two commands
  • May need to install piptools (but package name is pip-tools)
  • Update dependency list for RHEL
  • Update "Output" section (it is possible incorrect about the directories created, and may also need to be updated if we update CAMP to generate fewer output files)
  • General clean up

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
CAMP v3.0.0
Development

When branches are created from issues, their pull requests are automatically linked.

11-update-documentation JHUAPL-DTNMA/dtnma-camp
1 participant
@mfarina1