Skip to content

Commit

Permalink
Fix init
Browse files Browse the repository at this point in the history
  • Loading branch information
jan-janssen committed Nov 19, 2024
1 parent 8fa5d7b commit 307fb40
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 7 deletions.
6 changes: 4 additions & 2 deletions docs/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@ format: jb-book
root: README
chapters:
- file: installation.md
- file: examples.ipynb
- file: development.md
- file: 1-local.ipynb
- file: 2-hpc-submission.ipynb
- file: 3-hpc-allocation.ipynb
- file: trouble_shooting.md
- file: 4-developer.ipynb
- file: api.rst
12 changes: 10 additions & 2 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,14 @@ Or alternatively using the [conda package manager](https://anaconda.org/conda-fo
conda install -c conda-forge executorlib pygraphviz matplotlib networkx ipython
```
Again given the C++ bindings of [pygraphviz](https://pygraphviz.github.io/documentation/stable/) to the graphviz library
it is recommended to install a binary distribution. The pygraphviz documentation covers the [installation of pysqa](https://pygraphviz.github.io/documentation/stable/install.html)
it is recommended to install a binary distribution. The pygraphviz documentation covers the [installation of pygraphviz](https://pygraphviz.github.io/documentation/stable/install.html)
in more detail. Furthermore, [matplotlib](https://matplotlib.org), [networkx](https://networkx.org) and [ipython](https://ipython.readthedocs.io)
are installed as additional requirements for the visualisation.
are installed as additional requirements for the visualisation.

## For Developers
To install a specific development branch of executorlib you use the [Python package manager](https://pypi.org/project/executorlib/)
and directly install from the Github repository executorlib is hosted on:
```
pip install git+https://github.com/pyiron/executorlib.git@main
```
In this example the `main` branch is selected. To select a different branch just replace `main` with your target branch.
11 changes: 8 additions & 3 deletions executorlib/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
from typing import Optional

from executorlib._version import get_versions as _get_versions
from executorlib.interactive.executor import ExecutorWithDependencies, create_executor
from executorlib.interactive.executor import (
ExecutorWithDependencies as _ExecutorWithDependencies
)
from executorlib.interactive.executor import (
create_executor as _create_executor
)
from executorlib.standalone.inputcheck import (
check_plot_dependency_graph as _check_plot_dependency_graph,
)
Expand Down Expand Up @@ -199,7 +204,7 @@ def __new__(
)
elif not disable_dependencies:
_check_pysqa_config_directory(pysqa_config_directory=pysqa_config_directory)
return ExecutorWithDependencies(
return _ExecutorWithDependencies(
max_workers=max_workers,
backend=backend,
cache_directory=cache_directory,
Expand All @@ -218,7 +223,7 @@ def __new__(
_check_pysqa_config_directory(pysqa_config_directory=pysqa_config_directory)
_check_plot_dependency_graph(plot_dependency_graph=plot_dependency_graph)
_check_refresh_rate(refresh_rate=refresh_rate)
return create_executor(
return _create_executor(
max_workers=max_workers,
backend=backend,
cache_directory=cache_directory,
Expand Down

0 comments on commit 307fb40

Please sign in to comment.