Skip to content

Commit

Permalink
Better installation info
Browse files Browse the repository at this point in the history
  • Loading branch information
GiovanniBordiga committed Aug 23, 2024
1 parent f1c6036 commit bb65b7c
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,17 @@ To access and visualize the data:

## ⬇️ Installation

### Intsalling DifFlexMM only

Assuming you have access to the repo and ssh keys are set up in your GitHub account, you can install the package with

```bash
pip install git+ssh://git@github.com/bertoldi-collab/DifFlexMM.git
```

or you can clone the repository, `cd` into the `DifFlexMM` folder, and install with
### Installing DifFlexMM with examples of solved design problems

Clone the repository, `cd` into the `DifFlexMM` folder, and install with

```bash
pip install -e .
Expand All @@ -93,8 +97,8 @@ The dependency management of the project is done via [poetry](https://python-poe

To get started:

- Install [poetry](https://python-poetry.org/docs/)
- Clone the repo
- Install [poetry](https://python-poetry.org/docs/).
- Clone the repository.
- `cd` into the root directory and run `poetry install`. This will create the poetry environment with all the necessary dependencies.
- If you are using vscode, search for `venv path` in the settings and paste `~/.cache/pypoetry/virtualenvs` in the `venv path` field. Then select the poetry enviroment as python enviroment for the project.

Expand Down

0 comments on commit bb65b7c

Please sign in to comment.