diff --git a/docs/sphinx/_static/logo.png b/docs/sphinx/_static/logo.png new file mode 100644 index 0000000..cb616af Binary files /dev/null and b/docs/sphinx/_static/logo.png differ diff --git a/docs/sphinx/_static/systems.png b/docs/sphinx/_static/systems.png new file mode 100644 index 0000000..ede92c4 Binary files /dev/null and b/docs/sphinx/_static/systems.png differ diff --git a/docs/sphinx/conf.py b/docs/sphinx/conf.py index 232fa92..f4b396f 100644 --- a/docs/sphinx/conf.py +++ b/docs/sphinx/conf.py @@ -40,6 +40,7 @@ html_theme = "sphinxawesome_theme" html_static_path = ["_static"] html_title = f"{project} {release}" +html_css_files = ["custom.css"] # -- Autodoc options --------------------------------------------------------- diff --git a/docs/sphinx/index.rst b/docs/sphinx/index.rst index 801e662..28b0cab 100644 --- a/docs/sphinx/index.rst +++ b/docs/sphinx/index.rst @@ -1,15 +1,132 @@ -WEAC documentation -================== +WEAC API Documentation +====================== + +**WEAC** (Weak Layer Anticrack Nucleation Model) is a Python implementation of closed-form analytical models for the analysis of dry-snow slab avalanche release. + +.. raw:: html + +

+ + Release + + + Release + + + Release + +

+ +What is WEAC? +------------- + +WEAC implements closed-form analytical models for the `mechanical analysis of dry-snow slabs on compliant weak layers `_, the `prediction of anticrack onset `_, and allows for the `analysis of stratified snow covers `_. + +The model covers: +- **Propagation saw tests** (a) +- **Skier-loaded weak layers** (b) +- **Weak-layer crack nucleation** (c) + +.. image:: _static/systems.png + :alt: WEAC System Overview + :width: 600px + :align: center + + +Quick Start +----------- + +.. code-block:: bash + + pip install weac + +.. code-block:: python + + import weac + + # Create a scenario configuration + scenario = weac.components.scenario_config.ScenarioConfig() + + # Run analysis + results = weac.analysis.analyzer.Analyzer.analyze(scenario) + +**🐙 View on GitHub:** `GitHub Repository `_ + +Key Features +------------ + +* **Closed-form analytical models** for snow slab mechanics +* **Weak layer analysis** with compliance and collapse modeling +* **Anticrack prediction** using mixed-mode failure criteria +* **Stratified snow cover** analysis capabilities +* **Python-native** implementation with comprehensive documentation +* **Jupyter notebook** support for interactive analysis + +Documentation Structure +----------------------- + +.. toctree:: + :maxdepth: 2 + :caption: Getting Started + + weac + weac.components + weac.core + weac.analysis .. toctree:: :maxdepth: 2 - :caption: Contents: + :caption: Utilities & Tools + + weac.utils + weac.logging_config + +.. toctree:: + :maxdepth: 2 + :caption: Examples & Reference modules +Research & Citations +-------------------- + +**Cite the software:** +Rosendahl, P. L., Schneider, J., & Weissgraeber, P. (2022). Weak Layer Anticrack Nucleation Model (WEAC). Zenodo. https://doi.org/10.5281/zenodo.5773113 + +**Key publications:** +- `A closed-form model for layered snow slabs `_ (Weißgraeber & Rosendahl, 2023) +- `Modeling snow slab avalanches caused by weak-layer failure `_ (Rosendahl & Weißgraeber, 2020) + +Support & Community +------------------- + +* `Report bugs `_ +* `Request features `_ +* `View releases `_ +* `Download from PyPI `_ + +Getting Help +------------ + +* **Documentation**: This site provides comprehensive API documentation +* **Examples**: Check the modules section for usage examples +* **Research Papers**: Refer to the publications listed above for theoretical background +* **GitHub**: Visit the repository for source code and issue tracking + +**Need help?** Open an issue on GitHub or check the documentation structure below. + Indices and tables -================== +------------------ * :ref:`genindex` * :ref:`modindex` * :ref:`search` + +.. |Version| image:: https://img.shields.io/github/v/release/2phi/weac.svg?display_name=tag&color=f99a44&style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIAAAAtCAYAAADsvzj/AAAACXBIWXMAAAsSAAALEgHS3X78AAAClUlEQVRoge1Z0W2DMBC9Vv0vGzQblE5QugEjZISMwAZNN2AEOkEzAtmAbkAmuMrSWbKezmBsC9IoT7KU4OPw8707G/PAzHQLeLwJFnciV4g7kWvDnci14WaIPCXeXxDRnohq51pHRC0RjYm+l8Gs7JGtYeaRdfTMXCT4tm0vviwGZm6ZeYe2sQ9oPQRcdAkESiCAGMUmiUjjcXxSrsdGIQR9KpEBHtKIjMoMRKZIjBJl1X+KrAYIL8ptzEiid/LCRZlCpJKGmka0C3PCVzhOTuEockZEa1p+uGTNAA7MXHvu9yV2D3YHp2/ITURL/hPYuESxdGr324FiCXfz85iTiCYpLI2ofbdvNyGpcoZwcvmdG8R+YhYH6POtR83MhGHEo4kUHl0fwA6j0cJEaBhBUoVS8rHYRBHxkdCqFNZ9N1q+3GhmnnXUxhVDBAenhloplQxJjrNsYaOhbVO8e7lk0A07XOuLXC2r/aQsFGtlPxDyS0mspNBaTPoI6Hp2k10X5LXsFa4JLCKBRPBLXQIiVIGqVUzV35T2//FJEzTXqwKeTl6D3ip6pz/c/YWFRE9e/pe4f9F7Ps5p0iklMG9BAzoJdAOUQfancV2CLKGEGl7ppw4TMgKZbjoDTP08OGXiN6I6IGIPuR/DD4nZGXxJXJa9N6Pp/GDIpdvOWBAx7W00tH2WXz0kkOVonsfTD4Yf6eoKZqo/Z22FYhoWjlFdKmHFWt9H6mkiGiyOktUk7DWAZ2Ry9HT1+R4wJpfrExUfrQx5HC+9ZHpdy5HWxOJq1AK1iSyU651yrUobEnkN3j7EYAtpZUtGrQxkWz5QSsTwUXv30akcH5nK7sWW0jrIl+0siL109sSmJwwu2KzJcn7WY6I/gB+kRV89venQwAAAABJRU5ErkJggg== + :target: https://github.com/2phi/weac/releases + +.. |PyPI| image:: https://img.shields.io/pypi/v/weac.svg?logo=python&logoColor=white&color=f46b58&style=flat-square + :target: https://pypi.org/project/weac/ + +.. |DOI| image:: https://img.shields.io/badge/DOI-10.5281/zenodo.5773113-f03a6d.svg?style=flat-square + :target: https://zenodo.org/badge/latestdoi/203163531 diff --git a/docs/sphinx/modules.rst b/docs/sphinx/modules.rst index 2b33e39..a39dd56 100644 --- a/docs/sphinx/modules.rst +++ b/docs/sphinx/modules.rst @@ -1,7 +1,31 @@ -weac -==== +WEAC Package Overview +==================== .. toctree:: :maxdepth: 4 + :caption: Package Structure weac + weac.components + weac.core + weac.analysis + weac.utils + weac.logging_config + +Package Description +================== + +WEAC is a comprehensive Python package for analyzing dry-snow slab avalanche release using closed-form analytical models. The package is organized into several key modules: + +**Core Components:** +- :doc:`weac.components` - Configuration and data structures +- :doc:`weac.core` - Core mathematical models and solvers +- :doc:`weac.analysis` - Analysis tools and result processing +- :doc:`weac.utils` - Utility functions and helpers + +**Key Features:** +- Weak layer analysis with compliance modeling +- Anticrack prediction using mixed-mode failure criteria +- Support for stratified snow covers +- Comprehensive configuration management +- Result visualization and analysis tools