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
Copy file name to clipboardExpand all lines: INSTALL.md
+18-19Lines changed: 18 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -76,21 +76,18 @@ Build the package:
76
76
python -m build
77
77
```
78
78
79
-
This command builds the packages into `./dist` directory. Note that the custom `sdist`command is implemented in [setup.py](./setup.py).
79
+
which build the packages into `./dist`
80
80
81
-
The custom `sdist`command adds the following steps:
81
+
Remark:
82
+
- do not run `python setup.py` which will not build the full package
83
+
- the described install process will:
82
84
83
-
* compiling the `corese-python-x.y.z-jar-with-dependencies.jar` file using the Gradle build tool. This jar file is required to run Corese using the `Py4J` bridge.
84
-
* downloading the `corese-core-x.y.z-jar-with-dependencies.jar` file from the Maven repository. This jar file is required to run Corese using the `JPype` bridge.
85
-
* copying the jar files to the `./resources` directory.
85
+
1/ compile the `corese-python-4.x.y-jar-with-dependencies.jar` file
86
+
2/ download the `corese-core-4.x.y-jar-with-dependencies.jar` file from maven
86
87
87
-
> [!NOTE]
88
-
> - do not run `python setup.py` that will not build the full package.
89
-
> - the versions of `pycorese` and Java libraries are maintained separately.
90
-
> - `corese-python` version should be the same as `corese-core` it depends on, for simplicity reasons.
91
-
> - the commands forthe first two steps are providedin the [Obtaining Java libraries manually](#obtain-java-libraries-manually) section.
88
+
- these two files are necessary to run the wrappers and are part of the distribution
92
89
93
-
## Testing the package
90
+
### test
94
91
95
92
From the top directory, or in the `./tests` sub-directory run the command:
96
93
@@ -140,22 +137,24 @@ pycorese 0.1.1
140
137
141
138
$ python -c 'import pycorese'
142
139
```
143
-
> [!NOTE]
144
-
> - change the version number accordingly.
145
140
141
+
## Appendix 1: run local python example
146
142
147
-
## Run a simple example
143
+
### Conda environment
148
144
149
-
Without installing the package you can run the following command (the default Java bridge is `py4j`):
0 commit comments