Skip to content

Commit

Permalink
Revert with-dependencies
Browse files Browse the repository at this point in the history
Updated README
  • Loading branch information
shermanlo77 committed Apr 8, 2021
1 parent 3248e25 commit 6ddd95a
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 30 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,20 @@ At `pom.xml`, run
```
mvn package
```
to compile the *Java* code. The compiled `.jar` file is stored in `target/Empirical_Null_Filter-X.X.X.jar` and can be used as an *ImageJ* plugin. Copies of libraries are stored in `target/libs/` and would need to be installed in *ImageJ* as well. Also included is `target/Empirical_Null_Filter-X.X.X-jar-with-dependencies.jar` which includes the required libraries within the `.jar` file.
to compile the *Java* code. The compiled `.jar` file is `target/Empirical_Null_Filter-X.X.X.jar` and can be used as an *ImageJ* plugin. Copies of required libraries are stored in `target/libs/` and would need to be installed in *ImageJ* as well.

The `Empirical_Null_Filter-X.X.X-jar-with-dependencies.jar` file shall be provided in the releases.
The required `.jar` files shall be provided in the releases.

## How to Install (*Fiji* recommended)

The required `.jar` files can be obtained by either compiling (CPU and GPU) or downloading from the releases (CPU only).

Installation can be done by copying the `.jar` files to *Fiji*'s directories or, in *Fiji*, using the *Plugins* menu followed by *Install...* (or Ctrl + Shift + M). The required `.jar` file is
* `Empirical_Null_Filter-X.X.X-jar-with-dependencies.jar` which includes all required libraries
* *OR* `target/Empirical_Null_Filter-X.X.X.jar` along with the required libraries in *Fiji*'s `jars/` directory such as `target/libs/commons-math3-3.6.1.jar`, `target/libs/jcuda-10.1.0.jar` and `target/libs/jcuda-natives-10.1.0-linux-x86_64.jar`.
Installation of `Empirical_Null_Filter-X.X.X.jar` can be done by copying the file into *Fiji*'s `plugins/` directory or, in *Fiji*, using the *Plugins* menu followed by *Install...* (or Ctrl + Shift + M).

The required `.jar` libraries are to be copied into *Fiji*'s `jars/` directory. They are:
* `commons-math3-3.6.1.jar` (may already be provided)
* `jcuda-10.1.0.jar`
* `jcuda-natives-10.1.0-linux-x86_64.jar`

## Options
<img src=filter_gui.png><br>
Expand Down
26 changes: 1 addition & 25 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>uk.ac.warwick.sip</groupId>
<artifactId>Empirical_Null_Filter</artifactId>
<version>3.0.0</version>
<version>2.1.1</version>
<packaging>jar</packaging>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
Expand Down Expand Up @@ -38,30 +38,6 @@
</executions>
</plugin>

<plugin>
<artifactId>maven-assembly-plugin</artifactId>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>single</goal>
</goals>
</execution>
</executions>
<configuration>
<archive>
<manifest>
<addClasspath>true</addClasspath>
<classpathPrefix>libs/</classpathPrefix>
<mainClass>Empirical_Null_Filter</mainClass>
</manifest>
</archive>
<descriptorRefs>
<descriptorRef>jar-with-dependencies</descriptorRef>
</descriptorRefs>
</configuration>
</plugin>

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
Expand Down

0 comments on commit 6ddd95a

Please # to comment.