moducomp 0.7.7__tar.gz → 0.7.9__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.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: moducomp
3
- Version: 0.7.7
3
+ Version: 0.7.9
4
4
  Summary: moducomp: metabolic module completeness and complementarity for microbiomes.
5
5
  Keywords: bioinformatics,microbiome,metabolic,kegg,genomics
6
6
  Author-email: "Juan C. Villada" <jvillada@lbl.gov>
@@ -77,6 +77,8 @@ Small test data sets ship with `moducomp`. After installation you can confirm th
77
77
  moducomp test --ncpus 16 --calculate-complementarity 2 --eggnog-data-dir "$EGGNOG_DATA_DIR"
78
78
  ```
79
79
 
80
+ The test command runs in low-memory mode by default. If you have plenty of RAM and want full-memory mode, add `--fullmem` (or `--full-mem`).
81
+
80
82
  ### Developer install (Pixi)
81
83
 
82
84
  If you want to download the code and develop locally:
@@ -125,7 +127,7 @@ You should see the command line help without errors.
125
127
 
126
128
  ### ⚠️ Important note 2
127
129
 
128
- `moducomp` is specifically designed for large scale analysis of microbiomes with hundreds of members, and works on Linux systems with at least **64GB of RAM**. Nevertheless, it can be run on **smaller systems with less RAM, using the flag `--lowmem` when running the `pipeline` command**.
130
+ `moducomp` is specifically designed for large scale analysis of microbiomes with hundreds of members, and works on Linux systems with at least **64GB of RAM**. Nevertheless, it can be run on **smaller systems with less RAM, using the flag `--lowmem` (`--low-mem`) when running the `pipeline` command**. The `test` command uses low-memory mode by default and can be switched to full memory with `--fullmem` (`--full-mem`).
129
131
 
130
132
  ### Notes on bundled test data
131
133
 
@@ -162,7 +164,7 @@ moducomp pipeline \
162
164
  --ncpus <number_of_cpus_to_use> \
163
165
  --calculate-complementarity <N> # 0 to disable, 2 for 2-member, 3 for 3-member complementarity.
164
166
  # Optional flags:
165
- # --lowmem # Optional: Use this if you have less than 64GB of RAM
167
+ # --lowmem/--fullmem # Optional: Use low-mem if you have less than 64GB of RAM (default is full mem)
166
168
  # --adapt-headers # If your FASTA headers need modification
167
169
  # --del-tmp # To delete temporary files
168
170
  # --eggnog-data-dir /path # If EGGNOG_DATA_DIR is not set
@@ -52,6 +52,8 @@ Small test data sets ship with `moducomp`. After installation you can confirm th
52
52
  moducomp test --ncpus 16 --calculate-complementarity 2 --eggnog-data-dir "$EGGNOG_DATA_DIR"
53
53
  ```
54
54
 
55
+ The test command runs in low-memory mode by default. If you have plenty of RAM and want full-memory mode, add `--fullmem` (or `--full-mem`).
56
+
55
57
  ### Developer install (Pixi)
56
58
 
57
59
  If you want to download the code and develop locally:
@@ -100,7 +102,7 @@ You should see the command line help without errors.
100
102
 
101
103
  ### ⚠️ Important note 2
102
104
 
103
- `moducomp` is specifically designed for large scale analysis of microbiomes with hundreds of members, and works on Linux systems with at least **64GB of RAM**. Nevertheless, it can be run on **smaller systems with less RAM, using the flag `--lowmem` when running the `pipeline` command**.
105
+ `moducomp` is specifically designed for large scale analysis of microbiomes with hundreds of members, and works on Linux systems with at least **64GB of RAM**. Nevertheless, it can be run on **smaller systems with less RAM, using the flag `--lowmem` (`--low-mem`) when running the `pipeline` command**. The `test` command uses low-memory mode by default and can be switched to full memory with `--fullmem` (`--full-mem`).
104
106
 
105
107
  ### Notes on bundled test data
106
108
 
@@ -137,7 +139,7 @@ moducomp pipeline \
137
139
  --ncpus <number_of_cpus_to_use> \
138
140
  --calculate-complementarity <N> # 0 to disable, 2 for 2-member, 3 for 3-member complementarity.
139
141
  # Optional flags:
140
- # --lowmem # Optional: Use this if you have less than 64GB of RAM
142
+ # --lowmem/--fullmem # Optional: Use low-mem if you have less than 64GB of RAM (default is full mem)
141
143
  # --adapt-headers # If your FASTA headers need modification
142
144
  # --del-tmp # To delete temporary files
143
145
  # --eggnog-data-dir /path # If EGGNOG_DATA_DIR is not set
@@ -2,7 +2,7 @@
2
2
  moducomp: metabolic module completeness and complementarity for microbiomes.
3
3
  """
4
4
 
5
- __version__ = "0.7.7"
5
+ __version__ = "0.7.9"
6
6
  __author__ = "Juan C. Villada"
7
7
  __email__ = "jvillada@lbl.gov"
8
8
  __title__ = "moducomp"