Documentation: depinning-inertia-2024.readthedocs.io

depinning_inertia_2024

Interface between data and FrictionQPotSpringBlock.

Getting started:

1. Install dependencies. For example using Conda:

   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:

   python -m pip install . -v --no-build-isolation --no-deps

3. Build the docs:

   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.