Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Upgrading the README #1

Merged
merged 1 commit into from
Jul 14, 2024
Merged

Upgrading the README #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/CI.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ jobs:
sudo apt-get update
sudo apt-get install mpi-default-bin
sudo apt-get install libopm-simulators-bin
sudo apt-get install texlive-fonts-recommended texlive-fonts-extra dvipng cm-super

- name: Install test dependecies
run: |
Expand Down
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,14 @@
Quick generation of PNG figures from a simulation model given any 2D slide.

## Installation
To install the _plopm_ executable in an existing Python enviornment:

You can install the Python requirements in a virtual environment with the following commands:
```bash
pip install git+https://github.com/cssr-tools/plopm.git
```

If you are interested in modifying the source code, then you can clone the repository and
install the Python requirements in a virtual environment with the following commands:

```bash
# Clone the repo
Expand Down
Loading