Skip to content
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
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,7 @@ dask-scratch-space

*.h5
!tests/data/distograms_pdbs/pdbs.h5
!tests/data/dataset_expected/structures/*/*/*/*/*.h5
!tests/data/dataset_expected/structures/*/*/*/*/*.h5

*.egg-info
build
9 changes: 9 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# include everything in the sdist (be careful — this will bundle all files)
global-include *

recursive-exclude tests *
recursive-exclude .github *
recursive-exclude .pytest_cache *
recursive-exclude build *
recursive-exclude *.egg-info *
recursive-exclude dist *
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,28 @@ PYTHONPATH='.' python3 -u ${FRIDATA_PATH}/fridata.py \
-e ${EMBEDDER_TYPE}
```

## Running as a CLI tool

Assuming all `Instalation and activation` steps succeeded.

0. Go into `FRIdata` directory

```
cd <path into FRIdata>
```

1. Install as a CLI tool

```
python3 -m pip install -e .
```

2. Now FRIdata can be run as a CLI tool

```
$ fridata <...>
```

## Running on HPC

Running FRIdata on HPC differs on CPU and GPU nodes. This instruction set is valid for HPC hosted in PLGrid infrastructure. Running on other infrastructures may require additional adjustments.
Expand Down
48 changes: 48 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
[build-system]
requires = ["setuptools>=61.0", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "FRIdata"
version = "0.1.0"
readme = "README.md"
requires-python = ">=3.10"
dependencies = [
"foldcomp",
"pydantic>=2.8.2",
"scipy>=1.14.0",
"h5py",
"matplotlib",
"biotite>=0.41.2",
"numpy>=1.26.4,<1.27.0",
"genson",
"bs4",
"bio~=1.7.0",
"pytest",
"pytest-order",
"dask>=2024.4.2,<2025.0.0",
"dask[dataframe]",
"distributed>=2024.4.2,<2025.0.0",
"python-dotenv",
"tables",
"biopython",
"bokeh>=2.4.2,<3.0.0",
"pdbfixer",
"mamba",
"transformers",
"tqdm",
"pytorch-gpu",
"esm"
]

[project.scripts]
fridata = "fridata:main"

[tool.setuptools]
# fridata.py is a single-module at project root; install as py-module
py-modules = ["fridata"]
include-package-data = true

[tool.setuptools.packages.find]
where = ["."]
include = ["toolbox*"]
Loading