Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: Reduce non-optional dependencies #137

Merged
merged 3 commits into from
Apr 23, 2024
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
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -142,3 +142,6 @@ docs_build

# MLFlow
**/mlruns

# Testing
*.png
22 changes: 13 additions & 9 deletions data/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,30 @@

## Prerequisites

We use `dvc` to manage the data. You can install the required packages by
installing the benchmarks requirements.
We use `dvc` to manage the data. Install the required packages by:

```
pip install -e .[benchmarks]
pip install dvc dvc-gdrive
```

## Downloading the data

The data is stored in a remote storage on GDrive.
To download the data, you can run:
The data is stored in a remote storage on GDrive, so you need to authenticate
with the GDrive.

To download, e.g., the `navierstokes` data, run within the `data` directory:

```
cd data
dvc pull <NAME>
dvc pull navierstokes
```

where `<NAME>` is the name of the data set you want to download,
e.g., `flame` or `navierstokes`, or empty.
To download all data sets, run:

```
dvc pull
```

Below, you can find a list of available data sets.

## Data sets

Expand Down
43 changes: 19 additions & 24 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,38 +23,35 @@ keywords = [
]
dynamic = ["version"]
dependencies = [
"black", # code formatting
"flake8", # code analysis
"isort", # import sorting

# --------- linters --------- #
"pre-commit", # hooks for applying linters on commit
"pudb", # debugger
"pytest", # tests

# --------- others --------- #
"python-dotenv", # loading env variables from .env file
"rich", # beautiful text formatting in terminal
"sh", # for running bash commands in some tests

# --------- dependencies --------- #
"torch>=2.1.0,<3.0.0",
"matplotlib",
"pandas",
"setuptools",
"numpy",
"matplotlib",
"scipy",
"dvc",
"dvc-gdrive",
"pandas",
"torch>=2.1.0,<3.0.0",
"mlflow",
"optuna>=3.5.0,<4.0.0",
]

[project.optional-dependencies]
dev = [
"setuptools",
# === Optional dependencies for tests ===
"optuna>=3.5.0,<4.0.0",
"gmsh",
"deepxde",

# === Code quality ===
"black",
"flake8",
"isort",
"pre-commit",
"pudb",

# === Testing ===
"pytest",
"pytest-cov",
"nbmake",

# === Documentation ===
"markdown-captions",
"mike",
"mkdocs==1.5.2",
Expand All @@ -71,8 +68,6 @@ dev = [
"mknotebooks>=0.8.0",
"neoteroi-mkdocs",
"pygments",
"gmsh",
"deepxde",
]

[tool.setuptools.dynamic]
Expand Down
Loading