You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-9Lines changed: 19 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -31,16 +31,21 @@ cd mesa_frames
31
31
If you want to install it into a new environment:
32
32
33
33
```bash
34
-
conda create -n myenv -f requirements.txt
35
-
pip install -e .
34
+
conda create -n myenv
36
35
```
37
36
38
37
If you want to install it into an existing environment:
39
38
40
39
```bash
41
40
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]
44
49
```
45
50
46
51
### Installing in a Python Virtual Environment
@@ -50,18 +55,23 @@ If you want to install it into a new environment:
50
55
```bash
51
56
python3 -m venv myenv
52
57
source myenv/bin/activate # On Windows, use `myenv\Scripts\activate`
53
-
pip install -r requirements.txt
54
-
pip install -e .
55
58
```
56
59
57
60
If you want to install it into an existing environment:
58
61
59
62
```bash
60
63
source myenv/bin/activate # On Windows, use `myenv\Scripts\activate`
61
-
pip install -r requirements.txt
62
-
pip install -e .
63
64
```
64
65
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
+
65
75
## Usage
66
76
67
77
**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
143
153
- The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
144
154
- The software is provided "as is", without warranty of any kind.
145
155
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.
0 commit comments