Skip to content

Commit

Permalink
Update README re: installation details
Browse files Browse the repository at this point in the history
  • Loading branch information
caufieldjh authored Oct 21, 2024
1 parent db5dd28 commit a6c5581
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,15 @@ See also the app on [curategpt.io](https://curategpt.io) (note: this is sometime
subset of the functionality of the local app)


## Installation
## Getting started

### User installation

CurateGPT is available on Pypi and may be installed with `pip`:

`pip install curategpt`

### Developer installation

You will first need to [install Poetry](https://python-poetry.org/docs/#installation).

Expand All @@ -29,6 +37,8 @@ and install the dependencies:
poetry install
```

### API keys

In order to get the best performance from CurateGPT, we recommend getting an OpenAI API key, and setting it:

```
Expand All @@ -37,6 +47,8 @@ export OPENAI_API_KEY=<your key>

(for members of Monarch: ask on Slack if you would like to use the group key)

CurateGPT will also work with other large language models - see "Selecting models" below.

## Loading example data and running the app

You initially start with an empty database. You can load whatever you like into this
Expand Down

0 comments on commit a6c5581

Please sign in to comment.