Skip to content

Commit

Permalink
updates documentation to remove pipenv
Browse files Browse the repository at this point in the history
  • Loading branch information
BWMac committed Jan 8, 2024
1 parent 1d2f585 commit 886da8f
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 19 deletions.
7 changes: 3 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,19 +101,18 @@ This often provides additional considerations and avoids unnecessary work.
cd orca
```

4. Install `pipx` to easily run Python CLI tools like `tox` and `pipenv`.

4. Create an isolated virtual environment containing package dependencies,
including those needed for development (*e.g.* testing, documentation) by running:

```console
pipx run tox -e pipenv
./dev_setup.sh <your_python_version>
source py-orca-venv-<your_python_version>/bin/activate
```

5. Install [pre-commit] hooks:

```
pipenv run pre-commit install
pre-commit install
```

`orca` comes with a lot of hooks configured to automatically help the
Expand Down
15 changes: 0 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,21 +24,6 @@ Refer to [`.env.example`](.env.example) for the format of their values as well a

Once your environment is set, you can create a virtual environment, install the Python dependencies, and run the demonstration script (after downloading it) as follows. Note that you will need to update the `s3_prefix` parameter so that it points to an S3 bucket that is accessible to your Tower workspace.

### Using pipenv
```bash
# Create and activate a Python virtual environment (tested with Python 3.11)
pipenv shell

# Install Python dependencies
pipenv install

# If development dependencies are required to be installed
pipenv install -d

# Run the script using an example dataset
python3 demo.py run --dataset_id 'syn51514585' --s3_prefix 's3://orca-service-test-project-tower-bucket/outputs'
```

### Manually creating a virtual environment
```bash
# Create and activate a Python virtual environment (tested with Python 3.10)
Expand Down

0 comments on commit 886da8f

Please sign in to comment.