Skip to content

Commit 863f7c0

Browse files
committed
Merge requirements.txt into pyproject.toml
1 parent 29010c1 commit 863f7c0

File tree

3 files changed

+32
-13
lines changed

3 files changed

+32
-13
lines changed

README.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,16 +31,21 @@ cd mesa_frames
3131
If you want to install it into a new environment:
3232

3333
```bash
34-
conda create -n myenv -f requirements.txt
35-
pip install -e .
34+
conda create -n myenv
3635
```
3736

3837
If you want to install it into an existing environment:
3938

4039
```bash
4140
conda activate myenv
42-
conda install -f requirements.txt
43-
pip install -e .
41+
```
42+
43+
Then, to install mesa-frames itself:
44+
```bash
45+
# For pandas backend
46+
pip install -e .[pandas]
47+
# Alternatively, for Polars backend
48+
pip install -e .[polars]
4449
```
4550

4651
### Installing in a Python Virtual Environment
@@ -50,18 +55,23 @@ If you want to install it into a new environment:
5055
```bash
5156
python3 -m venv myenv
5257
source myenv/bin/activate # On Windows, use `myenv\Scripts\activate`
53-
pip install -r requirements.txt
54-
pip install -e .
5558
```
5659

5760
If you want to install it into an existing environment:
5861

5962
```bash
6063
source myenv/bin/activate # On Windows, use `myenv\Scripts\activate`
61-
pip install -r requirements.txt
62-
pip install -e .
6364
```
6465

66+
Then, to install mesa-frames itself:
67+
```bash
68+
# For pandas backend
69+
pip install -e .[pandas]
70+
# Alternatively, for Polars backend
71+
pip install -e .[polars]
72+
```
73+
74+
6575
## Usage
6676

6777
**Note:** mesa-frames is currently in its early stages of development. As such, the usage patterns and API are subject to change. Breaking changes may be introduced. Reports of feedback and issues are encouraged.
@@ -143,4 +153,4 @@ mesa-frames is made available under the MIT License. This license allows you to
143153
- The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
144154
- The software is provided "as is", without warranty of any kind.
145155

146-
For the full license text, see the [LICENSE](https://github.com/adamamer20/mesa_frames/blob/main/LICENSE) file in the GitHub repository.
156+
For the full license text, see the [LICENSE](https://github.com/adamamer20/mesa_frames/blob/main/LICENSE) file in the GitHub repository.

pyproject.toml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,19 @@ authors = [
1010
{ name = "Adam Amer" },
1111
]
1212
license = { text = "MIT" }
13+
dependencies = [
14+
"numpy~=2.0",
15+
]
16+
17+
[project.optional-dependencies]
18+
pandas = [
19+
"pandas~=2.2",
20+
"geopandas",
21+
"pyarrow",
22+
]
23+
polars = [
24+
"polars",
25+
]
1326

1427
[tool.hatch.build.targets.wheel]
1528
packages = ["mesa_frames"]

requirements.txt

Lines changed: 0 additions & 4 deletions
This file was deleted.

0 commit comments

Comments
 (0)