Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ cython_debug/

*/pressure_traces_*
*.csv
/Tutorials
# /Tutorials
.DS_Store
/playground_files

Expand Down
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ repos:
- id: check-yaml # check YAML files for syntax errors
- id: check-json # check JSON files for syntax errors
- id: check-added-large-files # check for large files
args: ['--maxkb=500'] # set the max file size to 500KB
args: ['--maxkb=2048'] # set the max file size to 2MB
- id: check-case-conflict # check for case conflicts in filenames.
- id: check-merge-conflict # This hook checks for merge conflict markers in files.
# It ensures that there are no unresolved merge conflicts in the codebase.
Expand Down
27 changes: 3 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,9 @@ The current version of the published package contains two models:

For other models currently under development, see the `dev` branch.

## Setup Conda or python virtual environment
## Setup a python virtual environment

Before installation of the ModularCirc package, please setup a virtual environment using either Conda or python virtual environment.

### Conda setup

Install Conda from https://docs.conda.io/projects/conda/en/stable/user-guide/install/index.html

Run:

```
conda create --name <yourenvname>
conda activate <yourenvname>
```

Proceed to installing the ModularCirc package.
Before installation of the ModularCirc package, please setup a virtual environment using python virtual environment.

### Python virtual environment setup

Expand All @@ -42,14 +29,6 @@ Proceed to installing the ModularCirc package.

## Installing ModularCirc

### pip install

To install the pip package:

```bash
python -m pip install ModularCirc
```

### Installation from source:

Clone the ModularCirc GitHub repo locally.
Expand All @@ -64,7 +43,7 @@ cd ModularCirc
After downloading the GitHub repository, from the repo directory run:

```bash
pip install ./
pip install -e ".[notebooks]"
```

This will install the package based on the `pyproject.toml` file specifications.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading