Skip to content

Commit

Permalink
Update for bestdetector
Browse files Browse the repository at this point in the history
  • Loading branch information
robertdstein committed Feb 13, 2024
1 parent 91230d6 commit aa98091
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 2 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ API interactions for WINTER
[![PyPI version](https://badge.fury.io/py/winterapi.svg)](https://badge.fury.io/py/winterapi)

## Installation

We advise you to install the package in a virtual environment or conda environment.
You will need python 3.10 or later to use this package.

### Install from pypi
```bash
pip install winterapi
Expand All @@ -18,3 +22,25 @@ cd winterapi
pip install --editable ".[dev]"
pre-commit install
```

## Updating the package

You will need to occasionally update the package to get the latest features and bug fixes.
Sometimes the server will require a newer version of the package to interact with it,
and you will receive a warning when using winterapi.
You can update by running the following command:

### Updating for pypi
```bash
pip install --upgrade winterapi
```

or

### Updating from source
```bash
cd winterapi
git pull
pip install --editable ".[dev]"
pre-commit install
```
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "winterapi"
version = "1.0.0"
version = "1.1.0"
description = ""
authors = [
{name = "Robert Stein", email = "rdstein@caltech.edu"}
Expand Down Expand Up @@ -36,7 +36,7 @@ dependencies = [
"jupyter",
"backoff",
"pydantic",
"wintertoo>=1.2.0"
"wintertoo>=1.3.1"
]
[project.optional-dependencies]
dev = [
Expand Down

0 comments on commit aa98091

Please sign in to comment.