Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tdegeus/slip_nucleation_2023
Stress drop and dynamics
https://github.com/tdegeus/slip_nucleation_2023
Last synced: 4 days ago
JSON representation
Stress drop and dynamics
- Host: GitHub
- URL: https://github.com/tdegeus/slip_nucleation_2023
- Owner: tdegeus
- License: mit
- Created: 2019-04-18T08:57:30.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-02-29T10:17:46.000Z (8 months ago)
- Last Synced: 2024-04-16T06:53:20.160Z (7 months ago)
- Language: Python
- Size: 1.25 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![DOI](https://zenodo.org/badge/182052974.svg)](https://zenodo.org/doi/10.5281/zenodo.10723197)
[![ci](https://github.com/tdegeus/slip_nucleation_2023/workflows/CI/badge.svg)](https://github.com/tdegeus/slip_nucleation_2023/actions)
[![Documentation Status](https://readthedocs.org/projects/slip-nucleation-2023/badge/?version=latest)](https://slip-nucleation-2023.readthedocs.io/en/latest/?badge=latest)
[![pre-commit](https://github.com/tdegeus/slip_nucleation_2023/workflows/pre-commit/badge.svg)](https://github.com/tdegeus/slip_nucleation_2023/actions)**Documentation: [slip-nucleation-2023.readthedocs.io](https://slip-nucleation-2023.readthedocs.io)**
# slip_nucleation_2023
Interface between data and [FrictionQPotFEM](https://github.com/tdegeus/FrictionQPotFEM).
Getting started:
1. Install dependencies.
For example using Conda:```bash
mamba env update --file environment.yaml
```Tip: use a new environment.
Note: some of these dependences are needed, some are merely a convenience for running the simulations.2. Install this package:
```bash
python -m pip install . -v --no-build-isolation --no-deps
```3. Build the docs:
```bash
cd docs
make html
```Open `docs/_build/html/index.html` in a web browser.
**Warning:** This is a research code. The API and data structure may be subjected to changes.