Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/arcticsnow/topopyscale_documentation

Documentation of TopoPyScale

https://github.com/arcticsnow/topopyscale_documentation

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (8.1%) to scientific vocabulary
Last synced: 6 months ago · JSON representation

Repository

Documentation of TopoPyScale

Basic Info
Statistics
  • Stars: 1
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Archived
Created about 4 years ago · Last pushed 11 months ago
Metadata Files
Readme License

README.md

TopoPyScale_Documentation

Documentation of the TopoPyScale toolbox. https://topopyscale.readthedocs.io

S. Filhol, J. Fiddes, January 2022

Contributing to the Documentation

The documentation is written in Markdown with the tool https://www.mkdocs.org

  1. Create a local Python VE

```bash conda create -n rtdoc conda activate rtdoc pip install mkdocs sphinxrtdtheme mkdocs-material pygments

# cloning using SSH key git clone git@github.com:ArcticSnow/TopoPyScaleDocumentation.git cd TopoPyScaleDocumenation ```

  1. Modify a given file or create a new one. If you create a new one add it to mkdocs.yml

  2. run mkdocs serve to visualize the modification on your local machine

  3. open the URL: http://127.0.0.1:8000/ in your browser

For customization of the theme, please use the documentation https://squidfunk.github.io/mkdocs-material/. All custom parameters are in the file mkdocs.yml

Update the API documentation

Run this command from the TopoPyScale virtual environment with correct paths:

bash lazydocs --output-path="path/to/TopoPyScale_Documentation/docs" --overview-file="README.md" --src-base-url="https://github.com/ArcticSnow/TopoPyScale" path/to/TopoPyScale

Owner

  • Name: Simon Filhol
  • Login: ArcticSnow
  • Kind: user
  • Location: Norway
  • Company: University of Oslo

GitHub Events

Total
  • Push event: 2
Last Year
  • Push event: 2

Dependencies

requirements.txt pypi
  • mkdocs *
  • mkdocs-material *
  • pygments *