cosmopharm 0.0.10__tar.gz → 0.0.12__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {cosmopharm-0.0.10/src/cosmopharm.egg-info → cosmopharm-0.0.12}/PKG-INFO +57 -67
- {cosmopharm-0.0.10 → cosmopharm-0.0.12}/README.md +1 -11
- cosmopharm-0.0.12/README.rst +98 -0
- {cosmopharm-0.0.10 → cosmopharm-0.0.12}/setup.cfg +3 -3
- {cosmopharm-0.0.10 → cosmopharm-0.0.12/src/cosmopharm.egg-info}/PKG-INFO +57 -67
- {cosmopharm-0.0.10 → cosmopharm-0.0.12}/src/cosmopharm.egg-info/SOURCES.txt +1 -0
- {cosmopharm-0.0.10 → cosmopharm-0.0.12}/LICENSE +0 -0
- {cosmopharm-0.0.10 → cosmopharm-0.0.12}/setup.py +0 -0
- {cosmopharm-0.0.10 → cosmopharm-0.0.12}/src/cosmopharm/__init__.py +0 -0
- {cosmopharm-0.0.10 → cosmopharm-0.0.12}/src/cosmopharm/actmodels/__init__.py +0 -0
- {cosmopharm-0.0.10 → cosmopharm-0.0.12}/src/cosmopharm/actmodels/actmodel.py +0 -0
- {cosmopharm-0.0.10 → cosmopharm-0.0.12}/src/cosmopharm/actmodels/cosmo.py +0 -0
- {cosmopharm-0.0.10 → cosmopharm-0.0.12}/src/cosmopharm/components.py +0 -0
- {cosmopharm-0.0.10 → cosmopharm-0.0.12}/src/cosmopharm/equilibrium/__init__.py +0 -0
- {cosmopharm-0.0.10 → cosmopharm-0.0.12}/src/cosmopharm/equilibrium/lle.py +0 -0
- {cosmopharm-0.0.10 → cosmopharm-0.0.12}/src/cosmopharm/equilibrium/sle.py +0 -0
- {cosmopharm-0.0.10 → cosmopharm-0.0.12}/src/cosmopharm/utils/__init__.py +0 -0
- {cosmopharm-0.0.10 → cosmopharm-0.0.12}/src/cosmopharm/utils/convert.py +0 -0
- {cosmopharm-0.0.10 → cosmopharm-0.0.12}/src/cosmopharm/utils/helpers.py +0 -0
- {cosmopharm-0.0.10 → cosmopharm-0.0.12}/src/cosmopharm/utils/lle_scanner.py +0 -0
- {cosmopharm-0.0.10 → cosmopharm-0.0.12}/src/cosmopharm/utils/spacing.py +0 -0
- {cosmopharm-0.0.10 → cosmopharm-0.0.12}/src/cosmopharm.egg-info/dependency_links.txt +0 -0
- {cosmopharm-0.0.10 → cosmopharm-0.0.12}/src/cosmopharm.egg-info/requires.txt +0 -0
- {cosmopharm-0.0.10 → cosmopharm-0.0.12}/src/cosmopharm.egg-info/top_level.txt +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: cosmopharm
|
|
3
|
-
Version: 0.0.
|
|
3
|
+
Version: 0.0.12
|
|
4
4
|
Summary: Predictive modeling for drug-polymer compatibility in pharmaceutical formulations using COSMO-SAC.
|
|
5
5
|
Home-page: https://github.com/ivanantolo/cosmopharm,
|
|
6
6
|
Author: Ivan Antolovic
|
|
@@ -27,7 +27,7 @@ Classifier: Programming Language :: Python :: 3.11
|
|
|
27
27
|
Classifier: Programming Language :: Python :: 3.12
|
|
28
28
|
Classifier: Programming Language :: Python :: 3.13
|
|
29
29
|
Requires-Python: >=3.8
|
|
30
|
-
Description-Content-Type: text/
|
|
30
|
+
Description-Content-Type: text/x-rst
|
|
31
31
|
License-File: LICENSE
|
|
32
32
|
Requires-Dist: matplotlib>=3.0
|
|
33
33
|
Requires-Dist: numpy>=1.15
|
|
@@ -35,111 +35,101 @@ Requires-Dist: pandas>=1.0
|
|
|
35
35
|
Requires-Dist: scipy>=1.4
|
|
36
36
|
Requires-Dist: openpyxl>=3.0
|
|
37
37
|
|
|
38
|
-
|
|
38
|
+
COSMOPharm
|
|
39
|
+
==========
|
|
39
40
|
|
|
40
|
-
|
|
41
|
-
<img src="https://github.com/ivanantolo/cosmopharm/raw/main/TOC.png" alt="TOC Figure" width="400"/>
|
|
42
|
-
</p>
|
|
41
|
+
.. figure:: https://github.com/ivanantolo/cosmopharm/raw/main/TOC.png
|
|
43
42
|
|
|
44
|
-
<
|
|
43
|
+
Welcome to the COSMOPharm repository, accompanying `our paper in J. Chem. Theory Comput. <https://dx.doi.org/10.1021/acs.jctc.9b01016>`_. This project and its associated publication offer insights and a practical toolkit for researching drug-polymer and drug-solvent systems, aiming to provide the scientific community with the means to reproduce our findings and further the development of COSMO-SAC-based models.
|
|
45
44
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
<img src="https://raw.githubusercontent.com/ivanantolo/cosmopharm/main/TOC.png" alt="TOC Figure" width="400"/>
|
|
49
|
-
|
|
50
|
-
<!-- <p align="center"> -->
|
|
51
|
-
|
|
52
|
-
<!-- </p> -->
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
Welcome to the COSMOPharm repository, accompanying [our paper in *J. Chem. Theory Comput.*](https://dx.doi.org/10.1021/acs.jctc.9b01016). This project and its associated publication offer insights and a practical toolkit for researching drug-polymer and drug-solvent systems, aiming to provide the scientific community with the means to reproduce our findings and further the development of COSMO-SAC-based models.
|
|
56
|
-
|
|
57
|
-
## About
|
|
45
|
+
About
|
|
46
|
+
-----
|
|
58
47
|
|
|
59
48
|
COSMOPharm is a Python package designed to streamline the predictive modeling of drug-polymer compatibility, crucial for the development of pharmaceutical amorphous solid dispersions. Apart from that, it can also be used for the miscibility/solubility of drugs with/in common solvents. Leveraging the COSMO-SAC (Conductor-like Screening Model Segment Activity Coefficient) model, COSMOPharm offers a robust platform for scientists and researchers to predict solubility, miscibility, and phase behavior in drug formulation processes.
|
|
60
49
|
|
|
61
|
-
|
|
50
|
+
Features
|
|
51
|
+
--------
|
|
62
52
|
|
|
63
53
|
- **Compatibility Prediction**: Utilize open-source COSMO-SAC model for prediction of drug-polymer compatibility.
|
|
64
54
|
- **Solubility Calculation**: Calculate drug-polymer solubilities to guide the selection of suitable polymers for drug formulations.
|
|
65
55
|
- **Miscibility and Phase Behavior Analysis**: Analyze the miscibility of drug-polymer pairs and understand their phase behavior under various conditions.
|
|
66
56
|
- **User-friendly Interface**: Easy-to-use functions and comprehensive documentation to facilitate research and development in pharmaceutical sciences.
|
|
67
57
|
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
### Quick Installation
|
|
71
|
-
For most users, the quickest and easiest way to install COSMOPharm is via pip, which will manage all dependencies for you. Ensure you have already installed the cCOSMO library by following the instructions on the [COSMOSAC GitHub page](https://github.com/usnistgov/COSMOSAC).
|
|
58
|
+
Installation
|
|
59
|
+
------------
|
|
72
60
|
|
|
73
|
-
|
|
61
|
+
Quick Installation
|
|
62
|
+
~~~~~~~~~~~~~~~~~~
|
|
74
63
|
|
|
75
|
-
|
|
76
|
-
pip install cosmopharm
|
|
77
|
-
```
|
|
64
|
+
For most users, the quickest and easiest way to install COSMOPharm is via pip, which will manage all dependencies for you. Ensure you have already installed the cCOSMO library by following the instructions on the `COSMOSAC GitHub page <https://github.com/usnistgov/COSMOSAC>`_.
|
|
78
65
|
|
|
79
|
-
|
|
66
|
+
Once cCOSMO is installed, you can install COSMOPharm directly from `PyPI <https://pypi.org/project/cosmopharm/>`_:
|
|
80
67
|
|
|
81
|
-
|
|
68
|
+
.. code-block:: bash
|
|
82
69
|
|
|
83
|
-
|
|
70
|
+
pip install cosmopharm
|
|
84
71
|
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
git clone https://github.com/ivanantolo/cosmopharm
|
|
88
|
-
```
|
|
72
|
+
Advanced Installation Options
|
|
73
|
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
89
74
|
|
|
90
|
-
|
|
75
|
+
For users who need more control over the installation process (e.g., for development purposes or when integrating with other projects), COSMOPharm can also be installed by cloning the repository and installing manually.
|
|
91
76
|
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
```
|
|
77
|
+
Step 1: Clone the Repository
|
|
78
|
+
"""""""""""""""""""""""""""""
|
|
95
79
|
|
|
96
|
-
|
|
80
|
+
First, clone the COSMOPharm repository:
|
|
97
81
|
|
|
98
|
-
|
|
82
|
+
.. code-block:: bash
|
|
99
83
|
|
|
100
|
-
|
|
101
|
-
pip install .
|
|
102
|
-
```
|
|
84
|
+
git clone https://github.com/ivanantolo/cosmopharm
|
|
103
85
|
|
|
86
|
+
Step 2: Navigate to the Repository Directory
|
|
87
|
+
""""""""""""""""""""""""""""""""""""""""""""
|
|
104
88
|
|
|
105
|
-
|
|
89
|
+
.. code-block:: bash
|
|
106
90
|
|
|
107
|
-
|
|
91
|
+
cd cosmopharm
|
|
108
92
|
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
```
|
|
93
|
+
Option 1: Using pip to Install from Local Source
|
|
94
|
+
""""""""""""""""""""""""""""""""""""""""""""""""
|
|
112
95
|
|
|
113
|
-
|
|
96
|
+
This method installs COSMOPharm and manages all dependencies efficiently:
|
|
114
97
|
|
|
115
|
-
|
|
98
|
+
.. code-block:: bash
|
|
116
99
|
|
|
117
|
-
|
|
100
|
+
pip install .
|
|
118
101
|
|
|
119
|
-
|
|
102
|
+
Option 2: Using setup.py for Installation
|
|
103
|
+
""""""""""""""""""""""""""""""""""""""""""
|
|
120
104
|
|
|
121
|
-
|
|
122
|
-
# Example usage script: example_usage.py
|
|
105
|
+
Alternatively, you can run the setup script directly:
|
|
123
106
|
|
|
124
|
-
|
|
125
|
-
from cosmopharm import SLE, LLE, COSMOSAC
|
|
126
|
-
from cosmopharm.utils import read_params, create_components
|
|
107
|
+
.. code-block:: bash
|
|
127
108
|
|
|
128
|
-
|
|
129
|
-
```
|
|
109
|
+
python setup.py install
|
|
130
110
|
|
|
131
|
-
|
|
111
|
+
While this method is straightforward, using `pip` is generally preferred for its dependency management capabilities.
|
|
132
112
|
|
|
133
|
-
|
|
113
|
+
Please note: Before proceeding with either advanced installation option, ensure the cCOSMO library is installed as described at the beginning of this section.
|
|
134
114
|
|
|
135
|
-
|
|
115
|
+
Quick Start
|
|
116
|
+
-----------
|
|
136
117
|
|
|
118
|
+
Here's a quick example to get you started with COSMOPharm: `Example <https://github.com/ivanantolo/cosmopharm/blob/main/example_usage.py>`_
|
|
137
119
|
|
|
138
|
-
|
|
120
|
+
.. code-block:: python
|
|
139
121
|
|
|
140
|
-
|
|
122
|
+
# Example usage script: example_usage.py
|
|
123
|
+
|
|
124
|
+
import cCOSMO
|
|
125
|
+
from cosmopharm import SLE, LLE, COSMOSAC
|
|
126
|
+
from cosmopharm.utils import read_params, create_components
|
|
127
|
+
|
|
128
|
+
# Rest of the script...
|
|
141
129
|
|
|
130
|
+
Contributing / Getting Help
|
|
131
|
+
---------------------------
|
|
142
132
|
|
|
143
|
-
|
|
133
|
+
Contributions to COSMOPharm are welcome! We accept contributions via pull requests to the `GitHub repository <https://github.com/ivanantolo/cosmopharm>`_.
|
|
144
134
|
|
|
145
|
-
|
|
135
|
+
For bugs, feature requests, or other queries, please `open an issue <https://github.com/ivanantolo/cosmopharm/issues>`
|
|
@@ -1,19 +1,9 @@
|
|
|
1
1
|
# COSMOPharm
|
|
2
2
|
|
|
3
3
|
<p align="center">
|
|
4
|
-
<img src="
|
|
4
|
+
<img src="TOC.png" alt="TOC Figure" width="400"/>
|
|
5
5
|
</p>
|
|
6
6
|
|
|
7
|
-
<img src="https://github.com/ivanantolo/cosmopharm/raw/main/TOC.png" alt="TOC Figure" width="400"/>
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
<img src="https://raw.githubusercontent.com/ivanantolo/cosmopharm/main/TOC.png" alt="TOC Figure" width="400"/>
|
|
12
|
-
|
|
13
|
-
<!-- <p align="center"> -->
|
|
14
|
-
|
|
15
|
-
<!-- </p> -->
|
|
16
|
-
|
|
17
7
|
|
|
18
8
|
Welcome to the COSMOPharm repository, accompanying [our paper in *J. Chem. Theory Comput.*](https://dx.doi.org/10.1021/acs.jctc.9b01016). This project and its associated publication offer insights and a practical toolkit for researching drug-polymer and drug-solvent systems, aiming to provide the scientific community with the means to reproduce our findings and further the development of COSMO-SAC-based models.
|
|
19
9
|
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
COSMOPharm
|
|
2
|
+
==========
|
|
3
|
+
|
|
4
|
+
.. figure:: https://github.com/ivanantolo/cosmopharm/raw/main/TOC.png
|
|
5
|
+
|
|
6
|
+
Welcome to the COSMOPharm repository, accompanying `our paper in J. Chem. Theory Comput. <https://dx.doi.org/10.1021/acs.jctc.9b01016>`_. This project and its associated publication offer insights and a practical toolkit for researching drug-polymer and drug-solvent systems, aiming to provide the scientific community with the means to reproduce our findings and further the development of COSMO-SAC-based models.
|
|
7
|
+
|
|
8
|
+
About
|
|
9
|
+
-----
|
|
10
|
+
|
|
11
|
+
COSMOPharm is a Python package designed to streamline the predictive modeling of drug-polymer compatibility, crucial for the development of pharmaceutical amorphous solid dispersions. Apart from that, it can also be used for the miscibility/solubility of drugs with/in common solvents. Leveraging the COSMO-SAC (Conductor-like Screening Model Segment Activity Coefficient) model, COSMOPharm offers a robust platform for scientists and researchers to predict solubility, miscibility, and phase behavior in drug formulation processes.
|
|
12
|
+
|
|
13
|
+
Features
|
|
14
|
+
--------
|
|
15
|
+
|
|
16
|
+
- **Compatibility Prediction**: Utilize open-source COSMO-SAC model for prediction of drug-polymer compatibility.
|
|
17
|
+
- **Solubility Calculation**: Calculate drug-polymer solubilities to guide the selection of suitable polymers for drug formulations.
|
|
18
|
+
- **Miscibility and Phase Behavior Analysis**: Analyze the miscibility of drug-polymer pairs and understand their phase behavior under various conditions.
|
|
19
|
+
- **User-friendly Interface**: Easy-to-use functions and comprehensive documentation to facilitate research and development in pharmaceutical sciences.
|
|
20
|
+
|
|
21
|
+
Installation
|
|
22
|
+
------------
|
|
23
|
+
|
|
24
|
+
Quick Installation
|
|
25
|
+
~~~~~~~~~~~~~~~~~~
|
|
26
|
+
|
|
27
|
+
For most users, the quickest and easiest way to install COSMOPharm is via pip, which will manage all dependencies for you. Ensure you have already installed the cCOSMO library by following the instructions on the `COSMOSAC GitHub page <https://github.com/usnistgov/COSMOSAC>`_.
|
|
28
|
+
|
|
29
|
+
Once cCOSMO is installed, you can install COSMOPharm directly from `PyPI <https://pypi.org/project/cosmopharm/>`_:
|
|
30
|
+
|
|
31
|
+
.. code-block:: bash
|
|
32
|
+
|
|
33
|
+
pip install cosmopharm
|
|
34
|
+
|
|
35
|
+
Advanced Installation Options
|
|
36
|
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
37
|
+
|
|
38
|
+
For users who need more control over the installation process (e.g., for development purposes or when integrating with other projects), COSMOPharm can also be installed by cloning the repository and installing manually.
|
|
39
|
+
|
|
40
|
+
Step 1: Clone the Repository
|
|
41
|
+
"""""""""""""""""""""""""""""
|
|
42
|
+
|
|
43
|
+
First, clone the COSMOPharm repository:
|
|
44
|
+
|
|
45
|
+
.. code-block:: bash
|
|
46
|
+
|
|
47
|
+
git clone https://github.com/ivanantolo/cosmopharm
|
|
48
|
+
|
|
49
|
+
Step 2: Navigate to the Repository Directory
|
|
50
|
+
""""""""""""""""""""""""""""""""""""""""""""
|
|
51
|
+
|
|
52
|
+
.. code-block:: bash
|
|
53
|
+
|
|
54
|
+
cd cosmopharm
|
|
55
|
+
|
|
56
|
+
Option 1: Using pip to Install from Local Source
|
|
57
|
+
""""""""""""""""""""""""""""""""""""""""""""""""
|
|
58
|
+
|
|
59
|
+
This method installs COSMOPharm and manages all dependencies efficiently:
|
|
60
|
+
|
|
61
|
+
.. code-block:: bash
|
|
62
|
+
|
|
63
|
+
pip install .
|
|
64
|
+
|
|
65
|
+
Option 2: Using setup.py for Installation
|
|
66
|
+
""""""""""""""""""""""""""""""""""""""""""
|
|
67
|
+
|
|
68
|
+
Alternatively, you can run the setup script directly:
|
|
69
|
+
|
|
70
|
+
.. code-block:: bash
|
|
71
|
+
|
|
72
|
+
python setup.py install
|
|
73
|
+
|
|
74
|
+
While this method is straightforward, using `pip` is generally preferred for its dependency management capabilities.
|
|
75
|
+
|
|
76
|
+
Please note: Before proceeding with either advanced installation option, ensure the cCOSMO library is installed as described at the beginning of this section.
|
|
77
|
+
|
|
78
|
+
Quick Start
|
|
79
|
+
-----------
|
|
80
|
+
|
|
81
|
+
Here's a quick example to get you started with COSMOPharm: `Example <https://github.com/ivanantolo/cosmopharm/blob/main/example_usage.py>`_
|
|
82
|
+
|
|
83
|
+
.. code-block:: python
|
|
84
|
+
|
|
85
|
+
# Example usage script: example_usage.py
|
|
86
|
+
|
|
87
|
+
import cCOSMO
|
|
88
|
+
from cosmopharm import SLE, LLE, COSMOSAC
|
|
89
|
+
from cosmopharm.utils import read_params, create_components
|
|
90
|
+
|
|
91
|
+
# Rest of the script...
|
|
92
|
+
|
|
93
|
+
Contributing / Getting Help
|
|
94
|
+
---------------------------
|
|
95
|
+
|
|
96
|
+
Contributions to COSMOPharm are welcome! We accept contributions via pull requests to the `GitHub repository <https://github.com/ivanantolo/cosmopharm>`_.
|
|
97
|
+
|
|
98
|
+
For bugs, feature requests, or other queries, please `open an issue <https://github.com/ivanantolo/cosmopharm/issues>`
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
[metadata]
|
|
2
2
|
name = cosmopharm
|
|
3
|
-
version = 0.0.
|
|
3
|
+
version = 0.0.12
|
|
4
4
|
author = Ivan Antolovic
|
|
5
5
|
author_email = Ivan.Antolovic@tu-berlin.de
|
|
6
6
|
maintainer = Martin Klajmon
|
|
7
7
|
maintainer_email = Martin.Klajmon@vscht.cz
|
|
8
8
|
description =
|
|
9
9
|
Predictive modeling for drug-polymer compatibility in pharmaceutical formulations using COSMO-SAC.
|
|
10
|
-
long_description = file: README.
|
|
11
|
-
long_description_content_type = text/
|
|
10
|
+
long_description = file: README.rst
|
|
11
|
+
long_description_content_type = text/x-rst
|
|
12
12
|
keywords = Drug-Polymer Compatibility, Amorphous Solid Dispersions, Pharmaceutical Formulation, COSMO-SAC Model, Solubility Prediction, Miscibility Analysis, Phase Behavior Prediction, Pharmaceutical Sciences, Drug Formulation Research, Polymer Science, Predictive Modeling in Pharma, Drug Development Tools, Biopharmaceuticals
|
|
13
13
|
url = https://github.com/ivanantolo/cosmopharm,
|
|
14
14
|
license = MIT
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: cosmopharm
|
|
3
|
-
Version: 0.0.
|
|
3
|
+
Version: 0.0.12
|
|
4
4
|
Summary: Predictive modeling for drug-polymer compatibility in pharmaceutical formulations using COSMO-SAC.
|
|
5
5
|
Home-page: https://github.com/ivanantolo/cosmopharm,
|
|
6
6
|
Author: Ivan Antolovic
|
|
@@ -27,7 +27,7 @@ Classifier: Programming Language :: Python :: 3.11
|
|
|
27
27
|
Classifier: Programming Language :: Python :: 3.12
|
|
28
28
|
Classifier: Programming Language :: Python :: 3.13
|
|
29
29
|
Requires-Python: >=3.8
|
|
30
|
-
Description-Content-Type: text/
|
|
30
|
+
Description-Content-Type: text/x-rst
|
|
31
31
|
License-File: LICENSE
|
|
32
32
|
Requires-Dist: matplotlib>=3.0
|
|
33
33
|
Requires-Dist: numpy>=1.15
|
|
@@ -35,111 +35,101 @@ Requires-Dist: pandas>=1.0
|
|
|
35
35
|
Requires-Dist: scipy>=1.4
|
|
36
36
|
Requires-Dist: openpyxl>=3.0
|
|
37
37
|
|
|
38
|
-
|
|
38
|
+
COSMOPharm
|
|
39
|
+
==========
|
|
39
40
|
|
|
40
|
-
|
|
41
|
-
<img src="https://github.com/ivanantolo/cosmopharm/raw/main/TOC.png" alt="TOC Figure" width="400"/>
|
|
42
|
-
</p>
|
|
41
|
+
.. figure:: https://github.com/ivanantolo/cosmopharm/raw/main/TOC.png
|
|
43
42
|
|
|
44
|
-
<
|
|
43
|
+
Welcome to the COSMOPharm repository, accompanying `our paper in J. Chem. Theory Comput. <https://dx.doi.org/10.1021/acs.jctc.9b01016>`_. This project and its associated publication offer insights and a practical toolkit for researching drug-polymer and drug-solvent systems, aiming to provide the scientific community with the means to reproduce our findings and further the development of COSMO-SAC-based models.
|
|
45
44
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
<img src="https://raw.githubusercontent.com/ivanantolo/cosmopharm/main/TOC.png" alt="TOC Figure" width="400"/>
|
|
49
|
-
|
|
50
|
-
<!-- <p align="center"> -->
|
|
51
|
-
|
|
52
|
-
<!-- </p> -->
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
Welcome to the COSMOPharm repository, accompanying [our paper in *J. Chem. Theory Comput.*](https://dx.doi.org/10.1021/acs.jctc.9b01016). This project and its associated publication offer insights and a practical toolkit for researching drug-polymer and drug-solvent systems, aiming to provide the scientific community with the means to reproduce our findings and further the development of COSMO-SAC-based models.
|
|
56
|
-
|
|
57
|
-
## About
|
|
45
|
+
About
|
|
46
|
+
-----
|
|
58
47
|
|
|
59
48
|
COSMOPharm is a Python package designed to streamline the predictive modeling of drug-polymer compatibility, crucial for the development of pharmaceutical amorphous solid dispersions. Apart from that, it can also be used for the miscibility/solubility of drugs with/in common solvents. Leveraging the COSMO-SAC (Conductor-like Screening Model Segment Activity Coefficient) model, COSMOPharm offers a robust platform for scientists and researchers to predict solubility, miscibility, and phase behavior in drug formulation processes.
|
|
60
49
|
|
|
61
|
-
|
|
50
|
+
Features
|
|
51
|
+
--------
|
|
62
52
|
|
|
63
53
|
- **Compatibility Prediction**: Utilize open-source COSMO-SAC model for prediction of drug-polymer compatibility.
|
|
64
54
|
- **Solubility Calculation**: Calculate drug-polymer solubilities to guide the selection of suitable polymers for drug formulations.
|
|
65
55
|
- **Miscibility and Phase Behavior Analysis**: Analyze the miscibility of drug-polymer pairs and understand their phase behavior under various conditions.
|
|
66
56
|
- **User-friendly Interface**: Easy-to-use functions and comprehensive documentation to facilitate research and development in pharmaceutical sciences.
|
|
67
57
|
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
### Quick Installation
|
|
71
|
-
For most users, the quickest and easiest way to install COSMOPharm is via pip, which will manage all dependencies for you. Ensure you have already installed the cCOSMO library by following the instructions on the [COSMOSAC GitHub page](https://github.com/usnistgov/COSMOSAC).
|
|
58
|
+
Installation
|
|
59
|
+
------------
|
|
72
60
|
|
|
73
|
-
|
|
61
|
+
Quick Installation
|
|
62
|
+
~~~~~~~~~~~~~~~~~~
|
|
74
63
|
|
|
75
|
-
|
|
76
|
-
pip install cosmopharm
|
|
77
|
-
```
|
|
64
|
+
For most users, the quickest and easiest way to install COSMOPharm is via pip, which will manage all dependencies for you. Ensure you have already installed the cCOSMO library by following the instructions on the `COSMOSAC GitHub page <https://github.com/usnistgov/COSMOSAC>`_.
|
|
78
65
|
|
|
79
|
-
|
|
66
|
+
Once cCOSMO is installed, you can install COSMOPharm directly from `PyPI <https://pypi.org/project/cosmopharm/>`_:
|
|
80
67
|
|
|
81
|
-
|
|
68
|
+
.. code-block:: bash
|
|
82
69
|
|
|
83
|
-
|
|
70
|
+
pip install cosmopharm
|
|
84
71
|
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
git clone https://github.com/ivanantolo/cosmopharm
|
|
88
|
-
```
|
|
72
|
+
Advanced Installation Options
|
|
73
|
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
89
74
|
|
|
90
|
-
|
|
75
|
+
For users who need more control over the installation process (e.g., for development purposes or when integrating with other projects), COSMOPharm can also be installed by cloning the repository and installing manually.
|
|
91
76
|
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
```
|
|
77
|
+
Step 1: Clone the Repository
|
|
78
|
+
"""""""""""""""""""""""""""""
|
|
95
79
|
|
|
96
|
-
|
|
80
|
+
First, clone the COSMOPharm repository:
|
|
97
81
|
|
|
98
|
-
|
|
82
|
+
.. code-block:: bash
|
|
99
83
|
|
|
100
|
-
|
|
101
|
-
pip install .
|
|
102
|
-
```
|
|
84
|
+
git clone https://github.com/ivanantolo/cosmopharm
|
|
103
85
|
|
|
86
|
+
Step 2: Navigate to the Repository Directory
|
|
87
|
+
""""""""""""""""""""""""""""""""""""""""""""
|
|
104
88
|
|
|
105
|
-
|
|
89
|
+
.. code-block:: bash
|
|
106
90
|
|
|
107
|
-
|
|
91
|
+
cd cosmopharm
|
|
108
92
|
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
```
|
|
93
|
+
Option 1: Using pip to Install from Local Source
|
|
94
|
+
""""""""""""""""""""""""""""""""""""""""""""""""
|
|
112
95
|
|
|
113
|
-
|
|
96
|
+
This method installs COSMOPharm and manages all dependencies efficiently:
|
|
114
97
|
|
|
115
|
-
|
|
98
|
+
.. code-block:: bash
|
|
116
99
|
|
|
117
|
-
|
|
100
|
+
pip install .
|
|
118
101
|
|
|
119
|
-
|
|
102
|
+
Option 2: Using setup.py for Installation
|
|
103
|
+
""""""""""""""""""""""""""""""""""""""""""
|
|
120
104
|
|
|
121
|
-
|
|
122
|
-
# Example usage script: example_usage.py
|
|
105
|
+
Alternatively, you can run the setup script directly:
|
|
123
106
|
|
|
124
|
-
|
|
125
|
-
from cosmopharm import SLE, LLE, COSMOSAC
|
|
126
|
-
from cosmopharm.utils import read_params, create_components
|
|
107
|
+
.. code-block:: bash
|
|
127
108
|
|
|
128
|
-
|
|
129
|
-
```
|
|
109
|
+
python setup.py install
|
|
130
110
|
|
|
131
|
-
|
|
111
|
+
While this method is straightforward, using `pip` is generally preferred for its dependency management capabilities.
|
|
132
112
|
|
|
133
|
-
|
|
113
|
+
Please note: Before proceeding with either advanced installation option, ensure the cCOSMO library is installed as described at the beginning of this section.
|
|
134
114
|
|
|
135
|
-
|
|
115
|
+
Quick Start
|
|
116
|
+
-----------
|
|
136
117
|
|
|
118
|
+
Here's a quick example to get you started with COSMOPharm: `Example <https://github.com/ivanantolo/cosmopharm/blob/main/example_usage.py>`_
|
|
137
119
|
|
|
138
|
-
|
|
120
|
+
.. code-block:: python
|
|
139
121
|
|
|
140
|
-
|
|
122
|
+
# Example usage script: example_usage.py
|
|
123
|
+
|
|
124
|
+
import cCOSMO
|
|
125
|
+
from cosmopharm import SLE, LLE, COSMOSAC
|
|
126
|
+
from cosmopharm.utils import read_params, create_components
|
|
127
|
+
|
|
128
|
+
# Rest of the script...
|
|
141
129
|
|
|
130
|
+
Contributing / Getting Help
|
|
131
|
+
---------------------------
|
|
142
132
|
|
|
143
|
-
|
|
133
|
+
Contributions to COSMOPharm are welcome! We accept contributions via pull requests to the `GitHub repository <https://github.com/ivanantolo/cosmopharm>`_.
|
|
144
134
|
|
|
145
|
-
|
|
135
|
+
For bugs, feature requests, or other queries, please `open an issue <https://github.com/ivanantolo/cosmopharm/issues>`
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|