BWRedits

README.md

@@ -3,45 +3,56 @@ Just Another Conditional Quantile Estimator
 
 This Python module provides code to implement Jacques forecasting model.
 
-## Setup
-
 ### Prerequisites
 Before setting up this project:   
-    -  Python Version: Your machine will need to have an installed version of python that mets the `requires-pyhon` constraint in [pyproject.toml](https://github.com/reichlab/jacques/blob/BWRedits/pyproject.toml).  
-    -  That version of Python should be set as your current Python interpreter.  
+    -  Python Version: Your machine will need to have an installed version of python that meets the `requires-python` constraint in [pyproject.toml](https://github.com/reichlab/jacques/blob/BWRedits/pyproject.toml).  
+    -  That version of Python should be set as your current Python interpreter. 
 
-### Setup
-Follow the directions below to set this project up on your local machine.
+## Installing the package
 
-1. Clone this repository to your local computer and navigate to the corresponding directory.
 
-2. Create a Python virtual environment.
 
-```
-python m venv .venv
-```
+## Setup for local development
 
-3. Activate the virual environment.
+The instructions below outline how to set up a development environment based
+on uv tooling.
 
-```
-source .venv/bin/activate
-```
-**Note:** the command above is for Unix-based systems. If you're using Windows, the command is:
+Prerequisites:
 
-```
-.venv\Scripts\activate
-```
+- [uv](https://docs.astral.sh/uv/getting-started/installation/)
 
-4. Install the project's dependencies, which include the `jacques` dependencies:
+1. Clone this repository
+2. Change to the repo's root directory:
 
-```
-# if only need the dependencies necessary to run jacques
-pip install -r requirements/requirements.txt && pip install -e .
-```
+    ```bash
+    cd jacques
+    ```
 
-and the dependencies required for running the [demo.ipynb](https://github.com/reichlab/jacques/blob/BWRedits/demo.ipynb):
+3. Create a Python virtual environment and install dependencies. The command
+below creates a virtual environment in the `.venv` directory, installs Python
+if needed, installs project dependencies (including dev dependencies), and
+installs the package in
+[editable mode](https://setuptools.pypa.io/en/stable/userguide/development_mode.html):
 
+    ```bash
+    uv sync
+    ```
+
+
+### Updating dependencies
+
+Use [`uv add`](https://docs.astral.sh/uv/reference/cli/#uv-add) to include a
+new dependency in the project. This command will install the new dependency
+into the virtual environment, add it to `uv.lock`, and update the
+`dependencies` section of [`pyproject.toml`](pyproject.toml).
+
+```bash
+uv add <package-name>
 ```
-# if you'd like to be able to run the demo notebook
-pip install -r requirements/requirements-doc.txt && pip install -e .
-```
+
+To add a dependency to a specific group (adding a dev dependency, for example),
+use the `--group` flag:
+
+```bash
+uv add <package-name> --group dev
+```