Skip to content

Commit

Permalink
cleanup pyhton version issue
Browse files Browse the repository at this point in the history
  • Loading branch information
nick-fournier-rsg committed Aug 22, 2024
1 parent cde72b8 commit 6e20ad6
Show file tree
Hide file tree
Showing 6 changed files with 564 additions and 1,029 deletions.
16 changes: 16 additions & 0 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "Python Debugger: Current File",
"type": "debugpy",
"request": "launch",
"program": "${file}",
"console": "integratedTerminal",
"justMyCode": false
}
]
}
23 changes: 8 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,26 +31,19 @@ I have provided several different dependency management files to make it easier
### _Python Environment Update_!
In an effort to enhance stability I have used Poetry to manage the dependencies for this fork. I have migrated away from the older setup.py, setup.cfg, and requirements.txt files in lieu of the more modern and simpler pyproject.toml file. I also provided an environment.yml for Conda if that is preferred.

## Installing from GitHub
You can install this fork directly from GitHub using pip. This will install all dependencies and the forked version of PopulationSim to your *current* Python environment.

```bash
pip install git+https://github.com/nick-fournier-rsg/populationsim.git@v0.6.1#egg=populationsim
```
## Setup a population sim environment
Poetry is a modern dependency management tool used for both environment management and package management. It is similar to Conda but is more lightweight and is specifically designed for Python projects.

This will install the forked version of PopulationSim from this repository and all dependencies.
**Important** This package requires python version 3.9. You will need to install python 3.9 even if you have a newer version of python installed.


## Development install with pip
It is sometimes useful to install in an editable development mode. You may clone the repository and install with pip using the editable flag `-e`. This will install an editable version of PopulationSim from your local repository. This is useful if you want to make changes to the code and test them without having to reinstall the package.
## Installing from GitHub
You can install this fork directly from GitHub using pip. This will install all dependencies and the forked version of PopulationSim to your *current* Python environment.

```bash
# Create a new conda environment (or whatever environment manager you prefer)
conda create -n populationsim python=3.9

# Clone the repository
git clone -b v0.6.1 git@github.com:nick-fournier-rsg/populationsim.git
cd populationsim
pip install -e .
pip install git+https://github.com/nick-fournier-rsg/populationsim.git@v0.6.2#egg=populationsim
```

This will install the forked version of PopulationSim from this repository and all dependencies.

87 changes: 0 additions & 87 deletions environment.yml

This file was deleted.

Loading

0 comments on commit 6e20ad6

Please sign in to comment.