Skip to content

Commit 9235049

Browse files
2 parents 5964024 + d68bcb0 commit 9235049

File tree

1 file changed

+29
-2
lines changed

1 file changed

+29
-2
lines changed

README.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# ThermoRawFileParser
22

33
Wrapper around the .net (C#) ThermoFisher ThermoRawFileReader library for running on Linux with mono (works on Windows too). It takes a thermo RAW file as input and outputs a metadata file and the spectra in 3 possible formats
4-
* MGF: only MS2 spectra
4+
* MGF: only MS2 and MS3 spectra
55
* mzML and indexed mzML: both MS1 and MS2 spectra
66
* Apache Parquet: under development
77

@@ -20,6 +20,7 @@ For running on Windows, omit `mono`. The optional parameters only work in the -o
2020
ThermoRawFileParser.exe --help
2121
usage is (use -option=value for the optional arguments):
2222
-h, --help Prints out the options.
23+
--version Prints out the library version.
2324
-i, --input=VALUE The raw file input.
2425
-o, --output=VALUE The output directory. Specify this or an output
2526
file.
@@ -62,7 +63,33 @@ If you want to build the project using nuget, put the ThermoFisher.CommonCore.Ra
6263

6364
## Logging
6465

65-
The default log file is `ThermoRawFileParser.log`. The log settings can be changed in `log4net.config`.
66+
By default the parser only logs to console. To enable logging to file, uncomment the file appender in the `log4net.config` file.
67+
68+
```
69+
<log4net>
70+
<root>
71+
<level value="INFO" />
72+
<appender-ref ref="console" />
73+
<!--<appender-ref ref="file" />-->
74+
</root>
75+
<appender name="console" type="log4net.Appender.ConsoleAppender">
76+
<layout type="log4net.Layout.PatternLayout">
77+
<conversionPattern value="%date %level %logger - %message%newline" />
78+
</layout>
79+
</appender>
80+
<!--<appender name="file" type="log4net.Appender.RollingFileAppender">
81+
<file value="ThermoRawFileParser.log" />
82+
<appendToFile value="true" />
83+
<rollingStyle value="Size" />
84+
<maxSizeRollBackups value="5" />
85+
<maximumFileSize value="10MB" />
86+
<staticLogFileName value="true" />
87+
<layout type="log4net.Layout.PatternLayout">
88+
<conversionPattern value="%date [%thread] %level %logger - %message%newline" />
89+
</layout>
90+
</appender>-->
91+
</log4net>
92+
```
6693

6794
## Docker
6895

0 commit comments

Comments
 (0)