update README with cloning notes and adjust path in _path_fix.py for submodule import

This commit is contained in:
Joseph Hopfmüller
2024-11-15 21:21:50 +01:00
parent f7217a93bb
commit 5871c79501
2 changed files with 6 additions and 3 deletions

View File

@@ -13,10 +13,13 @@ Full license text in LICENSE file
# optical-regeneration
This repo has about 7.5GB of datasets in it. The download will take a while.
## Notes on cloning:
- This repo has about 7.5GB of datasets in it. The download will take a while.
- `pypho` is added as a submodule -> `--recurse-submodules`
```bash
git clone https://git.suuppl.dev/seppl/optical-regeneration.git
git clone --recurse-submodules https://git.suuppl.dev/seppl/optical-regeneration.git
```
## License

View File

@@ -5,5 +5,5 @@ from pathlib import Path
parent_dir = Path(__file__).parent
while not (parent_dir / "pypho" / "pypho").exists() and parent_dir != Path("/"):
parent_dir = parent_dir.parent
print(f"Adding '{parent_dir / "pypho"}' to 'sys.path' to enable import of '{parent_dir / 'pypho'}'")
print(f"Adding '{parent_dir / "pypho"}' to 'sys.path' to enable import of '{parent_dir / 'pypho' / 'pypho'}'")
sys.path.append(str(parent_dir / "pypho"))