sopsim 0.2.5__tar.gz → 0.2.7__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. {sopsim-0.2.5/sopsim.egg-info → sopsim-0.2.7}/PKG-INFO +6 -59
  2. {sopsim-0.2.5 → sopsim-0.2.7}/README.md +5 -58
  3. {sopsim-0.2.5 → sopsim-0.2.7}/pyproject.toml +1 -1
  4. {sopsim-0.2.5 → sopsim-0.2.7}/sopsim/config.py +1 -1
  5. {sopsim-0.2.5 → sopsim-0.2.7/sopsim.egg-info}/PKG-INFO +6 -59
  6. {sopsim-0.2.5 → sopsim-0.2.7}/MANIFEST.in +0 -0
  7. {sopsim-0.2.5 → sopsim-0.2.7}/setup.cfg +0 -0
  8. {sopsim-0.2.5 → sopsim-0.2.7}/sopsim/__init__.py +0 -0
  9. {sopsim-0.2.5 → sopsim-0.2.7}/sopsim/__main__.py +0 -0
  10. {sopsim-0.2.5 → sopsim-0.2.7}/sopsim/artifacts.py +0 -0
  11. {sopsim-0.2.5 → sopsim-0.2.7}/sopsim/cli.py +0 -0
  12. {sopsim-0.2.5 → sopsim-0.2.7}/sopsim/core.py +0 -0
  13. {sopsim-0.2.5 → sopsim-0.2.7}/sopsim/delta_in.py +0 -0
  14. {sopsim-0.2.5 → sopsim-0.2.7}/sopsim/filop_lent.py +0 -0
  15. {sopsim-0.2.5 → sopsim-0.2.7}/sopsim/filop_vectors.py +0 -0
  16. {sopsim-0.2.5 → sopsim-0.2.7}/sopsim/mat_files/Ang.mat +0 -0
  17. {sopsim-0.2.5 → sopsim-0.2.7}/sopsim/mat_files/Delta.mat +0 -0
  18. {sopsim-0.2.5 → sopsim-0.2.7}/sopsim/mat_files/Notch.mat +0 -0
  19. {sopsim-0.2.5 → sopsim-0.2.7}/sopsim/mat_files/kappa.mat +0 -0
  20. {sopsim-0.2.5 → sopsim-0.2.7}/sopsim/reference_data.py +0 -0
  21. {sopsim-0.2.5 → sopsim-0.2.7}/sopsim/run_sopsim.py +0 -0
  22. {sopsim-0.2.5 → sopsim-0.2.7}/sopsim/server.py +0 -0
  23. {sopsim-0.2.5 → sopsim-0.2.7}/sopsim/two_d_geom.py +0 -0
  24. {sopsim-0.2.5 → sopsim-0.2.7}/sopsim/web_dist/__init__.py +0 -0
  25. {sopsim-0.2.5 → sopsim-0.2.7}/sopsim/web_dist/assets/index-BwDTYCM6.js +0 -0
  26. {sopsim-0.2.5 → sopsim-0.2.7}/sopsim/web_dist/assets/index-CROLemY3.js +0 -0
  27. {sopsim-0.2.5 → sopsim-0.2.7}/sopsim/web_dist/assets/index-CY6Qs6iF.js +0 -0
  28. {sopsim-0.2.5 → sopsim-0.2.7}/sopsim/web_dist/assets/index-Cf-_Tx0y.css +0 -0
  29. {sopsim-0.2.5 → sopsim-0.2.7}/sopsim/web_dist/assets/index-Cr0O0uLv.js +0 -0
  30. {sopsim-0.2.5 → sopsim-0.2.7}/sopsim/web_dist/assets/index-CtnLOlUl.js +0 -0
  31. {sopsim-0.2.5 → sopsim-0.2.7}/sopsim/web_dist/assets/index-DqOYPuAV.css +0 -0
  32. {sopsim-0.2.5 → sopsim-0.2.7}/sopsim/web_dist/index.html +0 -0
  33. {sopsim-0.2.5 → sopsim-0.2.7}/sopsim.egg-info/SOURCES.txt +0 -0
  34. {sopsim-0.2.5 → sopsim-0.2.7}/sopsim.egg-info/dependency_links.txt +0 -0
  35. {sopsim-0.2.5 → sopsim-0.2.7}/sopsim.egg-info/entry_points.txt +0 -0
  36. {sopsim-0.2.5 → sopsim-0.2.7}/sopsim.egg-info/requires.txt +0 -0
  37. {sopsim-0.2.5 → sopsim-0.2.7}/sopsim.egg-info/top_level.txt +0 -0
  38. {sopsim-0.2.5 → sopsim-0.2.7}/tests/test_api_types.py +0 -0
  39. {sopsim-0.2.5 → sopsim-0.2.7}/tests/test_cli.py +0 -0
  40. {sopsim-0.2.5 → sopsim-0.2.7}/tests/test_config.py +0 -0
  41. {sopsim-0.2.5 → sopsim-0.2.7}/tests/test_filop_lent.py +0 -0
  42. {sopsim-0.2.5 → sopsim-0.2.7}/tests/test_server.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: sopsim
3
- Version: 0.2.5
3
+ Version: 0.2.7
4
4
  Summary: SOPSim simulation library
5
5
  Author: Olaolu Olugbenle, Dr. William Annan
6
6
  Requires-Python: >=3.9
@@ -39,9 +39,10 @@ sopsim run --nc 4 --filopodia-life-time 10 --out-dir output
39
39
 
40
40
  This writes plots and metadata into the `output/` directory.
41
41
 
42
- For help:
42
+ For help run one of:
43
43
 
44
44
  ```bash
45
+ sopsim --help
45
46
  sopsim run -h
46
47
  sopsim serve -h
47
48
  ```
@@ -114,7 +115,7 @@ Important notes:
114
115
 
115
116
  - `Nc = 4` implies a `4 x 4` tissue
116
117
  - `Nc >= 10` can take many hours to run, so use smaller values for testing
117
- - MATLAB reference mode is intended for deterministic comparison with the legacy MATLAB workflow
118
+ - MATLAB reference mode is intended for deterministic comparison with the legacy MATLAB workflow (RNG=12)
118
119
 
119
120
  ## Repository structure
120
121
 
@@ -137,62 +138,6 @@ Running a simulation creates a results directory containing:
137
138
  - `metadata.json`
138
139
  - the generated result files from the simulation run
139
140
 
140
- ## Developer notes
141
-
142
- The following notes are intended to help someone clone the repository and continue development.
143
-
144
- ### Clone and setup
145
-
146
- ```bash
147
- git clone <repo-url>
148
- cd SOPSim
149
- python -m venv .venv
150
- .venv\Scripts\activate
151
- pip install -U pip
152
- pip install -e .
153
- ```
154
-
155
- ### Install development extras
156
-
157
- If you need the build tooling for packaging and release work:
158
-
159
- ```bash
160
- pip install build twine
161
- ```
162
-
163
- ### Run tests
164
-
165
- ```bash
166
- pytest
167
- ```
168
-
169
- ### Local development workflow
170
-
171
- 1. Make changes in the package code under `sopsim/`
172
- 2. Reinstall the editable package if needed:
173
-
174
- ```bash
175
- pip install -e .
176
- ```
177
-
178
- 3. Test the CLI locally:
179
-
180
- ```bash
181
- sopsim run --nc 4 --out-dir output
182
- ```
183
-
184
- 4. Test the web app:
185
-
186
- ```bash
187
- sopsim serve
188
- ```
189
-
190
- ### Environment configuration notes
191
-
192
- - The server uses `python-dotenv` and reads environment variables from a local `.env` file if present.
193
- - The web server supports an optional `CORS_ALLOW_ORIGINS` environment variable for frontend origin control.
194
- - Do not commit secrets or local credentials to the repository.
195
-
196
141
  ## Publishing to PyPI
197
142
 
198
143
  ### Did you make updates to the library and now want to publish them? Here's how to publish
@@ -223,6 +168,8 @@ You may need to configure an API key to complete this process.
223
168
 
224
169
  ## Bug fixes
225
170
 
171
+ - `0.2.7`: README updates
172
+ - `0.2.6`: Updated READMES & re-built front-end
226
173
  - `0.2.5`: Updated the README to be more comprehensive for developers & updated bundled frontend to include link to live frontend (on the web)
227
174
  - `0.2.4`: Improved documentation for `FData`
228
175
  - `0.2.3`: Backend now works; frontend layout adjustments; help text wording improvement
@@ -22,9 +22,10 @@ sopsim run --nc 4 --filopodia-life-time 10 --out-dir output
22
22
 
23
23
  This writes plots and metadata into the `output/` directory.
24
24
 
25
- For help:
25
+ For help run one of:
26
26
 
27
27
  ```bash
28
+ sopsim --help
28
29
  sopsim run -h
29
30
  sopsim serve -h
30
31
  ```
@@ -97,7 +98,7 @@ Important notes:
97
98
 
98
99
  - `Nc = 4` implies a `4 x 4` tissue
99
100
  - `Nc >= 10` can take many hours to run, so use smaller values for testing
100
- - MATLAB reference mode is intended for deterministic comparison with the legacy MATLAB workflow
101
+ - MATLAB reference mode is intended for deterministic comparison with the legacy MATLAB workflow (RNG=12)
101
102
 
102
103
  ## Repository structure
103
104
 
@@ -120,62 +121,6 @@ Running a simulation creates a results directory containing:
120
121
  - `metadata.json`
121
122
  - the generated result files from the simulation run
122
123
 
123
- ## Developer notes
124
-
125
- The following notes are intended to help someone clone the repository and continue development.
126
-
127
- ### Clone and setup
128
-
129
- ```bash
130
- git clone <repo-url>
131
- cd SOPSim
132
- python -m venv .venv
133
- .venv\Scripts\activate
134
- pip install -U pip
135
- pip install -e .
136
- ```
137
-
138
- ### Install development extras
139
-
140
- If you need the build tooling for packaging and release work:
141
-
142
- ```bash
143
- pip install build twine
144
- ```
145
-
146
- ### Run tests
147
-
148
- ```bash
149
- pytest
150
- ```
151
-
152
- ### Local development workflow
153
-
154
- 1. Make changes in the package code under `sopsim/`
155
- 2. Reinstall the editable package if needed:
156
-
157
- ```bash
158
- pip install -e .
159
- ```
160
-
161
- 3. Test the CLI locally:
162
-
163
- ```bash
164
- sopsim run --nc 4 --out-dir output
165
- ```
166
-
167
- 4. Test the web app:
168
-
169
- ```bash
170
- sopsim serve
171
- ```
172
-
173
- ### Environment configuration notes
174
-
175
- - The server uses `python-dotenv` and reads environment variables from a local `.env` file if present.
176
- - The web server supports an optional `CORS_ALLOW_ORIGINS` environment variable for frontend origin control.
177
- - Do not commit secrets or local credentials to the repository.
178
-
179
124
  ## Publishing to PyPI
180
125
 
181
126
  ### Did you make updates to the library and now want to publish them? Here's how to publish
@@ -206,6 +151,8 @@ You may need to configure an API key to complete this process.
206
151
 
207
152
  ## Bug fixes
208
153
 
154
+ - `0.2.7`: README updates
155
+ - `0.2.6`: Updated READMES & re-built front-end
209
156
  - `0.2.5`: Updated the README to be more comprehensive for developers & updated bundled frontend to include link to live frontend (on the web)
210
157
  - `0.2.4`: Improved documentation for `FData`
211
158
  - `0.2.3`: Backend now works; frontend layout adjustments; help text wording improvement
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "sopsim"
7
- version = "0.2.5"
7
+ version = "0.2.7"
8
8
  description = "SOPSim simulation library"
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.9"
@@ -14,7 +14,7 @@ MIN_FILOPODIA_LIFE_TIME = 1
14
14
  NC_RUNTIME_WARNING_THRESHOLD = 10
15
15
  NC_VALIDATION_MESSAGE = f"Number of cells per row (Nc). Must be an integer >= {MIN_NC}."
16
16
  FILOPODIA_LIFE_TIME_VALIDATION_MESSAGE = f"filopodia_life_time must be an integer >= {MIN_FILOPODIA_LIFE_TIME}."
17
- MATLAB_REFERENCE_VALIDATION_MESSAGE = f"MATLAB reference mode is only supported when Nc={MATLAB_REFERENCE_NC}."
17
+ MATLAB_REFERENCE_VALIDATION_MESSAGE = f"MATLAB reference mode (uses MATLAB RNG=12) is only supported when Nc={MATLAB_REFERENCE_NC}."
18
18
 
19
19
 
20
20
  @dataclass(frozen=True)
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: sopsim
3
- Version: 0.2.5
3
+ Version: 0.2.7
4
4
  Summary: SOPSim simulation library
5
5
  Author: Olaolu Olugbenle, Dr. William Annan
6
6
  Requires-Python: >=3.9
@@ -39,9 +39,10 @@ sopsim run --nc 4 --filopodia-life-time 10 --out-dir output
39
39
 
40
40
  This writes plots and metadata into the `output/` directory.
41
41
 
42
- For help:
42
+ For help run one of:
43
43
 
44
44
  ```bash
45
+ sopsim --help
45
46
  sopsim run -h
46
47
  sopsim serve -h
47
48
  ```
@@ -114,7 +115,7 @@ Important notes:
114
115
 
115
116
  - `Nc = 4` implies a `4 x 4` tissue
116
117
  - `Nc >= 10` can take many hours to run, so use smaller values for testing
117
- - MATLAB reference mode is intended for deterministic comparison with the legacy MATLAB workflow
118
+ - MATLAB reference mode is intended for deterministic comparison with the legacy MATLAB workflow (RNG=12)
118
119
 
119
120
  ## Repository structure
120
121
 
@@ -137,62 +138,6 @@ Running a simulation creates a results directory containing:
137
138
  - `metadata.json`
138
139
  - the generated result files from the simulation run
139
140
 
140
- ## Developer notes
141
-
142
- The following notes are intended to help someone clone the repository and continue development.
143
-
144
- ### Clone and setup
145
-
146
- ```bash
147
- git clone <repo-url>
148
- cd SOPSim
149
- python -m venv .venv
150
- .venv\Scripts\activate
151
- pip install -U pip
152
- pip install -e .
153
- ```
154
-
155
- ### Install development extras
156
-
157
- If you need the build tooling for packaging and release work:
158
-
159
- ```bash
160
- pip install build twine
161
- ```
162
-
163
- ### Run tests
164
-
165
- ```bash
166
- pytest
167
- ```
168
-
169
- ### Local development workflow
170
-
171
- 1. Make changes in the package code under `sopsim/`
172
- 2. Reinstall the editable package if needed:
173
-
174
- ```bash
175
- pip install -e .
176
- ```
177
-
178
- 3. Test the CLI locally:
179
-
180
- ```bash
181
- sopsim run --nc 4 --out-dir output
182
- ```
183
-
184
- 4. Test the web app:
185
-
186
- ```bash
187
- sopsim serve
188
- ```
189
-
190
- ### Environment configuration notes
191
-
192
- - The server uses `python-dotenv` and reads environment variables from a local `.env` file if present.
193
- - The web server supports an optional `CORS_ALLOW_ORIGINS` environment variable for frontend origin control.
194
- - Do not commit secrets or local credentials to the repository.
195
-
196
141
  ## Publishing to PyPI
197
142
 
198
143
  ### Did you make updates to the library and now want to publish them? Here's how to publish
@@ -223,6 +168,8 @@ You may need to configure an API key to complete this process.
223
168
 
224
169
  ## Bug fixes
225
170
 
171
+ - `0.2.7`: README updates
172
+ - `0.2.6`: Updated READMES & re-built front-end
226
173
  - `0.2.5`: Updated the README to be more comprehensive for developers & updated bundled frontend to include link to live frontend (on the web)
227
174
  - `0.2.4`: Improved documentation for `FData`
228
175
  - `0.2.3`: Backend now works; frontend layout adjustments; help text wording improvement
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes