Skip to content

Commit

Permalink
Update README.md details
Browse files Browse the repository at this point in the history
  • Loading branch information
vjf authored Dec 23, 2024
1 parent fa14721 commit 907b52b
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,16 @@
![Test Status](https://github.com/AuScope/geomodel-2-3dweb/actions/workflows/tests.yml/badge.svg)
[![Coverage Status](https://raw.githubusercontent.com/AuScope/geomodel-2-3dweb/master/test/badge/coverage-badge.svg)]()

# geomodel-2-3dweb
# AuScope Geomodels Portal back-end

Generates 3D web versions of geological models primarily for geomodelportal website (https://github.com/AuScope/geomodelportal)

## Development

### To configure
#### To configure

1. Install Python v3.7 or higher (https://www.python.org/)
2. Install PDM (https://pdm.fming.dev/latest/)
1. Install Python v3.9 or higher (https://www.python.org/)
2. Install PDM (https://pdm.fming.dev/latest/) and jq (https://jqlang.github.io/jq/)

NB: pyassimp requires the assimp shared library which may need to be compiled and installed separately

Expand All @@ -23,7 +24,7 @@ export COLLADA2GLTF_BIN=/home/fred/github/COLLADA2GLTF/build/
6. 'pdm install' will install the python library dependencies
'eval $(pdm venv activate)' will start a Python env, 'deactivate' to exit

### To convert some GOCAD files to GLTF or COLLADA (*.ts, *.pl, small *.vs, *.wl) NetCDF4 (large *.vs), GZIP (*.vo, *.sg). *.gp files can also be converted.
#### To convert some GOCAD files to GLTF or COLLADA (*.ts, *.pl, small *.vs, *.wl) NetCDF4 (large *.vs), GZIP (*.vo, *.sg). *.gp files can also be converted.

Run [conv_webasset.py](scripts/conv_webasset.py). You must give it either the directory where the GOCAD files reside, or a GOCAD file plus a conversion parameter file. This [README](web_build/input/README.md) explains the format of the conversion parameter file.

Expand Down Expand Up @@ -52,15 +53,15 @@ where _config.json_ looks like this:
Use the '-g' flag to generate COLLADA files


### Converting GOCAD models for use in geomodelportal website
#### Converting GOCAD models for use in geomodelportal website

[batch_proc.py](web_build/batch_proc.py) is a simple batch script used to convert the GOCAD models for the website.

### Building a borehole database
#### Building a borehole database

[make_boreholes.py](web_build/make_boreholes.py) is a script to create a database of NVCL borehole objects to display within the model. See this [README](web_build/README.md) for more information.

### Release Procedure
## Release Procedure

1. Tag with "PORTAL_RELEASE_YYYYMMDD" annotated tag
```
Expand All @@ -71,19 +72,19 @@ git push --tags origin master
3. Once step 2 is complete, run the 'release_models.yml' action inputting the tag name
4. The 'release_models.yml' will build all the model files and insert them into the release

### Code Documentation
## Code Documentation

Autogenerated API Documentation is available [here](https://auscope.github.io/geomodel-2-3dweb/)
Autogenerated Source Code Documentation is available [here](https://auscope.github.io/geomodel-2-3dweb/)

Please see [README](doc_src/README.md) file for documentation generation details.

### Acknowledgements
## Acknowledgements

Funding provided by [AuScope Pty Ltd](https://www.auscope.org.au/)

SKUA/GOCAD software from the [Paradigm Academic Software Program](http://www.pdgm.com/affiliations/academic-software-programs/) was used to view some types of GOCAD object files and produce sample GOCAD OBJECT files used for testing

### Citation
## Citation

Please cite as:

Expand Down

0 comments on commit 907b52b

Please sign in to comment.