Skip to content

Commit

Permalink
Merge branch 'main' of github.com:BartBruininks/mdvcontainment into main
Browse files Browse the repository at this point in the history
  • Loading branch information
BartBruininks committed May 14, 2024
2 parents 2e76da9 + 78d1830 commit 69dca7b
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,19 @@ MDVContainment has been tested to work with python >= 3.8 and Ubuntu 20.04.6 LTS

# Installation
## Using git
```
pip3 install git+https://github.com/BartBruininks/mdvcontainment
```

or

```
git clone [email protected]:BartBruininks/mdvcontainment.git
cd mdvcontainment
pip install .
```
# Usage
For worked examples in jupyter notebooks, take a look at the `example_notebooks` folder. The 2D and 3D examples are run on syntethic data for clarity, the MD tutorial uses real MD data.
```
## Minimum required imports
import mdvcontainment as mdvc
Expand Down

0 comments on commit 69dca7b

Please sign in to comment.