Skip to content

update readme with pypi based instructions #247

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ParticularlyPythonicBS merged 1 commit into from
Jan 8, 2026
Merged

update readme with pypi based instructions #247

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 21 additions & 43 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# TEMOA Version 4.0.0a1
# TEMOA

[![PyPI](https://img.shields.io/pypi/v/temoa?label=pypi%20package)](https://pypi.org/project/temoa/)
[![CI](https://github.com/TemoaProject/temoa/actions/workflows/ci.yml/badge.svg?branch=unstable)](https://github.com/TemoaProject/temoa/actions/workflows/ci.yml)
[![Documentation Status](https://readthedocs.org/projects/temoa/badge/?version=latest)](https://temoa.readthedocs.io/en/latest/?badge=latest)
[![Python 3.12+](https://img.shields.io/badge/python-3.12%2B-blue)](https://pyreadiness.org/3.12/)
Expand All @@ -14,57 +15,28 @@ TEMOA (Tools for Energy Model Optimization and Analysis) is a sophisticated ener

## Quick Start

### Using uv (Recommended)

The fastest way to get started with Temoa:

```bash
# Install uv if you haven't already
curl -LsSf https://astral.sh/uv/install.sh | sh

```

Bleeding-edge nightly development installation:

In a directory initialized with uv (e.g., `uv init .`) run:
### Standard Installation

```bash
uv add temoa --default-index https://pypi.temoaproject.org/simple/ --index https://pypi.org/simple/

# or

pip install --index-url https://temoaproject.github.io/temoa-nightlies/simple/ temoa --extra-index-url https://pypi.org/simple/

```

Or clone the repository and install in development mode:
# Install from PyPI in a virtual environment
python -m venv .venv

```bash
# Activate virtual environment
# On Linux/Mac:
source .venv/bin/activate
# On Windows:
.venv\Scripts\activate

# Clone and setup development environment
git clone https://github.com/TemoaProject/temoa.git
cd temoa
uv sync --all-extras --dev

# Run your first model
uv run temoa tutorial my_first_model
uv run temoa run my_first_model.toml
```

### Standard Installation

```bash
# Install from PyPI (not yet available)
# Install temoa
pip install temoa

# Or install from source
pip install -e .
```

### Get Started in 30 Seconds

In a virtual env with temoa installed, run:

```bash
# Create tutorial files
# Create tutorial files in the current directory
temoa tutorial quick_start

# Run the model
Expand Down Expand Up @@ -92,7 +64,13 @@ The Temoa package is organized into clear modules:

### Development Installation

For users who want to contribute or modify Temoa should install in development mode using `uv`:
For users who want to contribute to or modify Temoa should install in development mode using `uv`:

```bash
# Install uv if you haven't already
curl -LsSf https://astral.sh/uv/install.sh | sh

```
Comment on lines +67 to +73
Copy link

@coderabbitai coderabbitai bot Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix grammar and code block formatting.

Line 67 contains awkward phrasing. Additionally, the code block structure appears fragmented with an incomplete block between lines 69-73 and the next block at line 75.

✏️ Proposed fix 
-### Development Installation
-
-For users who want to contribute to or modify Temoa should install in development mode using `uv`:
-
-```bash
-# Install uv if you haven't already
-curl -LsSf https://astral.sh/uv/install.sh | sh
-
-```
+### Development Installation
+
+If you want to contribute to or modify Temoa, install in development mode using `uv`:
+
+```bash
+# Install uv if you haven't already
+curl -LsSf https://astral.sh/uv/install.sh | sh
 
 ```bash
 # Clone repository
🤖 Prompt for AI Agents 
In @README.md around lines 67 - 73, Rewrite the README section to fix grammar
and consolidate the fragmented code blocks: replace the awkward sentence on
contribution with "If you want to contribute to or modify Temoa, install in
development mode using `uv`", add a "### Development Installation" heading,
ensure the `bash` code fence begins before the curl command and includes the
curl install line, then immediately follow with the next code fence containing
the repository clone command so the install and clone steps are in separate,
correctly formed code blocks; update the lines around the existing curl and
subsequent code fence to remove the stray/incomplete triple backticks and ensure
proper Markdown code block formatting.


```bash
# Clone repository
Expand Down
13 changes: 6 additions & 7 deletions docs/source/quick_start.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,9 @@ First, it is highly recommended to use a Python virtual environment to manage de
Then, install Temoa:

.. parsed-literal::
# Install from PyPI (when 4.0 is released)
# Install from PyPI
$ pip install temoa

# Or install from nightlies (alpha/development versions)
$ pip install --index-url https://temoaproject.github.io/temoa-nightlies/simple/ temoa --extra-index-url https://pypi.org/simple/

# Get started
$ python -m temoa tutorial my_first_model
$ python -m temoa run my_first_model.toml
Expand All @@ -43,9 +40,8 @@ For faster dependency resolution:
$ uv init <dir_name>
$ cd <dir_name>


# add Temoa from nightlies to pyproject.toml
$ uv add temoa --default-index https://pypi.temoaproject.org/simple --index https://pypi.org/simple
# add Temoa from PyPI to pyproject.toml
$ uv add temoa

# Get started
$ uv run temoa tutorial my_first_model
Expand All @@ -63,6 +59,9 @@ If you want to contribute to Temoa or modify the code:
# Install in development mode with uv (recommended)
$ uv sync --all-extras --dev

# Install pre-commit hooks
$ uv run pre-commit install

For detailed contribution guidelines, see CONTRIBUTING.md in the repository.

Solvers
Expand Down