Skip to content

Commit 900a78d

Browse files
update readme with pypi based instructions
1 parent ac21b26 commit 900a78d

File tree

1 file changed

+14
-43
lines changed

1 file changed

+14
-43
lines changed

README.md

Lines changed: 14 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
# TEMOA Version 4.0.0a1
1+
# TEMOA
22

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

1516
## Quick Start
1617

17-
### Using uv (Recommended)
18-
19-
The fastest way to get started with Temoa:
20-
21-
```bash
22-
# Install uv if you haven't already
23-
curl -LsSf https://astral.sh/uv/install.sh | sh
24-
25-
```
26-
27-
Bleeding-edge nightly development installation:
28-
29-
In a directory initialized with uv (e.g., `uv init .`) run:
30-
31-
```bash
32-
uv add temoa --default-index https://pypi.temoaproject.org/simple/ --index https://pypi.org/simple/
33-
34-
# or
35-
36-
pip install --index-url https://temoaproject.github.io/temoa-nightlies/simple/ temoa --extra-index-url https://pypi.org/simple/
37-
38-
```
39-
40-
Or clone the repository and install in development mode:
41-
42-
```bash
43-
44-
# Clone and setup development environment
45-
git clone https://github.com/TemoaProject/temoa.git
46-
cd temoa
47-
uv sync --all-extras --dev
48-
49-
# Run your first model
50-
uv run temoa tutorial my_first_model
51-
uv run temoa run my_first_model.toml
52-
```
53-
5418
### Standard Installation
5519

5620
```bash
57-
# Install from PyPI (not yet available)
21+
# Install from PyPI in a virtual environment
22+
python -m venv .venv
23+
source .venv/bin/activate
5824
pip install temoa
59-
60-
# Or install from source
61-
pip install -e .
6225
```
6326

6427
### Get Started in 30 Seconds
6528

29+
In a virtual env with temoa installed, run:
30+
6631
```bash
67-
# Create tutorial files
32+
# Create tutorial files in the current directory
6833
temoa tutorial quick_start
6934

7035
# Run the model
@@ -94,6 +59,12 @@ The Temoa package is organized into clear modules:
9459

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

62+
```bash
63+
# Install uv if you haven't already
64+
curl -LsSf https://astral.sh/uv/install.sh | sh
65+
66+
```
67+
9768
```bash
9869
# Clone repository
9970
git clone https://github.com/TemoaProject/temoa.git

0 commit comments

Comments
 (0)