You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Fix Optuna dependency by Poetry dep group.
* Make optuna dependecy group optional.
* version bump and updated docs
---------
Co-authored-by: Gian Marco Ghiandoni <[email protected]>
Copy file name to clipboardExpand all lines: README.rst
+16-8Lines changed: 16 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -72,8 +72,8 @@ Requirements
72
72
rdkit # Chemoinformatics toolkit
73
73
74
74
75
-
Installation
76
-
------------
75
+
Installation via PyPI
76
+
---------------------
77
77
78
78
You can install *Jazzy* via pip_ from PyPI_:
79
79
@@ -82,30 +82,38 @@ You can install *Jazzy* via pip_ from PyPI_:
82
82
$ pip install jazzy
83
83
84
84
85
-
Installation from Source
86
-
------------------------
85
+
Installation via Poetry (for development)
86
+
-----------------------------------------
87
87
88
-
Requirements to install *Jazzy* from sources:
88
+
Requirements to install *Jazzy* from the code repository:
89
89
90
90
- `poetry`_
91
91
- `pyenv`_ or `conda`_
92
92
- python>=3.6
93
93
94
-
First check that ``poetry`` is running correctly (v1.0.10 at the time of writing)
94
+
First check that ``poetry`` is running (v1.4.1 at March 2023)
95
95
96
96
.. code:: console
97
97
98
98
$ poetry --version
99
-
Poetry version 1.0.10
99
+
Poetry version v1.4.1
100
100
101
-
Create a virtual environment (via ``pyenv`` or ``conda``) and activate it. Afterwards, clone the *Jazzy* project from GitHub and install it using ``poetry``
101
+
Create a virtual environment (via ``pyenv`` or ``conda``) and activate it. Afterwards, clone the *Jazzy* project from GitHub and install it using ``poetry``.
If you wish to replicate our parameter fitting (see ``data/optuna_fitting`` and ``optimisation``), you need to install the specific version of ``optuna``.
110
+
At the time of the study, we used ``optuna==2.3.0``. You can install that manually using ``pip`` or ``poetry``.
0 commit comments