Skip to content

Commit

Permalink
Merge pull request #393 from joshua-cogliati-inl/readme_update
Browse files Browse the repository at this point in the history
Adding notes on building HERON_DATA zip.
  • Loading branch information
dylanjm authored Nov 22, 2024
2 parents 8fbad70 + 959abe7 commit f9f60f2
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@
# python stuff
__pycache__
*.pyc
build_cfg/dist/
build_cfg/heron_ravenframework.egg-info/


# install stuff
/.ravenconfig.xml
Expand Down
16 changes: 15 additions & 1 deletion build_cfg/README
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
To build this, use the build module in python:
To build this, use the build module in python from the build_cfg directory:


python3 -m ensurepip
python3 -m pip install --upgrade build
python3 -m build

This will create packages in the dist directory.



To build the data zip, from the HERON directory:

#make sure that data and tests are clean
git clean -x -f -d data/ tests/

#build docs
(cd doc && ./make_docs.sh)

#create zip
(cd .. && zip -r HERON_DATA.zip HERON/doc/pdfs/*.pdf HERON/data/ HERON/tests/)

0 comments on commit f9f60f2

Please sign in to comment.