Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
P
PanTools
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
bioinformatics
PanTools
Commits
8be97eae
Commit
8be97eae
authored
1 year ago
by
Robin van Esch
Browse files
Options
Downloads
Patches
Plain Diff
Remove software requirements from index page; changed useful JVM options
parent
f9564112
No related branches found
No related tags found
2 merge requests
!251
Create release v4.3.2
,
!220
Remove software requirements from index page; changed useful JVM options
Pipeline
#83512
passed
1 year ago
Stage: test
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/source/index.rst
+9
-17
9 additions, 17 deletions
docs/source/index.rst
with
9 additions
and
17 deletions
docs/source/index.rst
+
9
−
17
View file @
8be97eae
...
...
@@ -44,18 +44,9 @@ PanTools currently provides these functionalities:
- Gene classification
- Phylogenetic methods
Requirements
Installation
------------
- \ **Java Virtual Machine**\ version 1.8 or higher, Add path to the
java executable to your OS path environment variable.
- \ **KMC**\ : A disk-based k-mer counter, After downloading the
appropriate version (linux, macos or windows), add path to the *kmc*
and *kmc_tools* executables to your OS path environment variable.
- \ **MCL**\ : The Markov Clustering Algorithm, After downloading and
compiling the software, add path to the *mcl* executable to your OS
path environment variable.
For installing and configuring all required software, please see our
:doc:`/getting_started/install` page.
...
...
@@ -67,15 +58,16 @@ the command line by:
.. substitution-code-block:: bash
$
java
<JVM options>
-jar pantools-|ProjectVersion|.jar
<subcommand> <arguments>
$
pantools
<JVM options> <subcommand> <arguments>
| **Useful JVM options**
| - **-server** : To optimize JIT compilations for higher performance
| - **-Xmn(a number followed by m/g)** : Minimum heap size in mega/giga
bytes
| - **-Xmx(a number followed by m/g)** : Maximum heap size in mega/giga
bytes
**Useful JVM options:**
- **-Xmn(a number followed by m/g)** : Minimum heap size in mega/giga
bytes
- **-Xmx(a number followed by m/g)** : Maximum heap size in mega/giga
bytes
- **-XX:StartFlightRecording=filename=<name>.jfr,disk=true** : Enable
the Flight Recorder
Options
-------
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment