Skip to content
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.

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

Merge requirements.txt into pyproject.toml #15

Merged
merged 1 commit into from
Jul 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
28 changes: 19 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,21 @@ cd mesa_frames
If you want to install it into a new environment:

```bash
conda create -n myenv -f requirements.txt
pip install -e .
conda create -n myenv
```

If you want to install it into an existing environment:

```bash
conda activate myenv
conda install -f requirements.txt
pip install -e .
```

Then, to install mesa-frames itself:
```bash
# For pandas backend
pip install -e .[pandas]
# Alternatively, for Polars backend
pip install -e .[polars]
```

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

If you want to install it into an existing environment:

```bash
source myenv/bin/activate # On Windows, use `myenv\Scripts\activate`
pip install -r requirements.txt
pip install -e .
```

Then, to install mesa-frames itself:
```bash
# For pandas backend
pip install -e .[pandas]
# Alternatively, for Polars backend
pip install -e .[polars]
```


## Usage

**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.
Expand Down Expand Up @@ -143,4 +153,4 @@ mesa-frames is made available under the MIT License. This license allows you to
- The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
- The software is provided "as is", without warranty of any kind.

For the full license text, see the [LICENSE](https://github.com/adamamer20/mesa_frames/blob/main/LICENSE) file in the GitHub repository.
For the full license text, see the [LICENSE](https://github.com/adamamer20/mesa_frames/blob/main/LICENSE) file in the GitHub repository.
13 changes: 13 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,19 @@ authors = [
{ name = "Adam Amer" },
]
license = { text = "MIT" }
dependencies = [
"numpy~=1.26",
]

[project.optional-dependencies]
pandas = [
"pandas~=2.2",
"geopandas",
"pyarrow",
]
polars = [
"polars",
]

[tool.hatch.build.targets.wheel]
packages = ["mesa_frames"]
4 changes: 0 additions & 4 deletions requirements.txt

This file was deleted.