Skip to content

Commit 99b77aa

Browse files
committed
Update readme for development stuff using uv
1 parent dc28b60 commit 99b77aa

File tree

1 file changed

+26
-8
lines changed

1 file changed

+26
-8
lines changed

README.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,30 @@
11
# PyFracVAL
2+
23
Implementation of FracVAL by [Morán, J. et al. 2019](https://www.sciencedirect.com/science/article/pii/S0010465519300323?via%3Dihub) in python.
34

5+
## Development
6+
7+
### Using UV
8+
9+
Create an environment (`numba` does not support python 3.13 yet, so please use 3.12 or lower):
10+
11+
```sh
12+
uv venv --python 3.12
13+
```
14+
15+
Sync the packages with the dependencies found in `pyproject.toml`:
16+
17+
```sh
18+
uv sync
19+
```
20+
421
## TODO
5-
- [ ] Fix PCA issues
6-
+ [X] Instability with arcos arguments, tied to monomer size somehow
7-
+ [ ] low fractal dimensions fail -> This is also happening for original FracVAL
8-
+ [ ] high fractal prefactors fail -> This is also happening for original FracVAL
9-
+ [X] yet to be understood infinite loop occurs sometimes
10-
- [ ] Allow distribution functions for monomer radii
11-
- [ ] Parallelize
12-
- [ ] High fractal dimensions are super slow -> Happens for FracVAL aswell, bit more noticeable for this implementation i feel
22+
23+
- [ ] Fix PCA issues
24+
- [x] Instability with arcos arguments, tied to monomer size somehow
25+
- [ ] low fractal dimensions fail -> This is also happening for original FracVAL
26+
- [ ] high fractal prefactors fail -> This is also happening for original FracVAL
27+
- [x] yet to be understood infinite loop occurs sometimes
28+
- [ ] Allow distribution functions for monomer radii
29+
- [ ] Parallelize
30+
- [ ] High fractal dimensions are super slow -> Happens for FracVAL aswell, bit more noticeable for this implementation i feel

0 commit comments

Comments
 (0)