https://github.com/tdegeus/depinning_inertia_2024

Shell between data and FrictionQPotSpringBlock
https://github.com/tdegeus/depinning_inertia_2024

depinning physics

Last synced: about 20 hours ago
JSON representation

Shell between data and FrictionQPotSpringBlock

• Host: GitHub
• URL: https://github.com/tdegeus/depinning_inertia_2024
• Owner: tdegeus
• License: mit
• Created: 2022-03-25T15:02:49.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-02-27T15:03:25.000Z (12 months ago)
• Last Synced: 2024-04-16T06:53:11.930Z (10 months ago)
• Topics: depinning, physics
• Language: Python
• Homepage: https://depinning-inertia-2024.readthedocs.io
• Size: 619 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10679735.svg)](https://doi.org/10.5281/zenodo.10679735)

[![ci](https://github.com/tdegeus/depinning_inertia_2024/workflows/CI/badge.svg)](https://github.com/tdegeus/depinning_inertia_2024/actions)

[![Documentation Status](https://readthedocs.org/projects/depinning-inertia-2024/badge/?version=latest)](https://depinning-inertia-2024.readthedocs.io/en/latest/?badge=latest)

[![pre-commit](https://github.com/tdegeus/depinning_inertia_2024/workflows/pre-commit/badge.svg)](https://github.com/tdegeus/depinning_inertia_2024/actions)

**Documentation: [depinning-inertia-2024.readthedocs.io](https://depinning-inertia-2024.readthedocs.io)**

# depinning_inertia_2024

Interface between data and [FrictionQPotSpringBlock](https://github.com/tdegeus/FrictionQPotSpringBlock).

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.