Update roadmap

tillbiskup · Jan 11, 2023 · a4eef1e · a4eef1e
1 parent 41073c4
commit a4eef1e
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 2 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -1,5 +1,19 @@
 cff-version: 1.2.0
-message: If you use this software, please cite it using these metadata.
+message: "If you use this software, please cite both the article from preferred-citation and the software itself."
+preferred-citation:
+  authors:
+    - family-names: Popp
+      given-names: Jara
+    - family-names: Biskup
+      given-names: Till
+      orcid: "https://orcid.org/0000-0003-2913-0004"
+  title: "ASpecD: A Modular Framework for the Analysis of Spectroscopic Data Focussing on Reproducibility and Good Scientific Practice"
+  doi: 10.1002/cmtd.202100097
+  journal: "Chemistry-Methods"
+  pages: e202100097
+  volume: 2
+  year: 2022
+  type: article
 title: ASpecD
 abstract: >
     ASpecD is a Python framework for handling spectroscopic data focussing on reproducibility. In short: Each and every processing step applied to your data will be recorded and can be traced back, and additionally, for each representation of your data (e.g., figures, tables) you can easily follow how the data shown have been processed and where they originate from.

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-0.8.0.dev16
+0.8.0.dev17
diff --git a/docs/roadmap.rst b/docs/roadmap.rst
@@ -8,6 +8,11 @@ A few ideas how to develop the project further, currently a list as a reminder f
 For version 0.8
 ===============
 
+* Documentation
+
+  * Metadata for data acquisition: document info file/refer to publication (and add reference in infofile module documentation)
+  * Add "Best Practices" section showing data publications using derived packages (currently only one: Järsvall et al., Chem. Mater. 2022)?
+
 * Usability
 
   * Importer/ImporterFactory should issue a warning if no dataset could be loaded, rather than silently continuing, as this often leads to downstream problems and exceptions thrown.
@@ -22,6 +27,10 @@ For version 0.8
 
   * MetadataUpdate/MetadataChange: Change metadata of a given dataset from within a recipe. Useful in case datasets contain (known) spurious or otherwise inappropriate metadata. (Metadata are provided manually and are therefore prone to human errors).
 
+* Logging
+
+  * Add loggers from other modules (than task) and derived packages
+
 * Add export tasks to dataset tasks
 
 * Recipe-driven data analysis:
@@ -43,6 +52,12 @@ For version 0.8
 
   * Looking for templates in user directory
 
+* Documentation:
+
+  * How to debug a recipe?
+
+  * Better document command-line options of the "serve" command
+
 
 For later versions
 ==================