Skip to content

Commit

Permalink
Adding contextualizing information in the documentation (#15)
Browse files Browse the repository at this point in the history
Co-authored-by: mkuehbach <[email protected]>
  • Loading branch information
mkuehbach and mkuehbach authored Jun 11, 2024
1 parent d3f3d17 commit adcfd67
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,20 @@ hide: toc
---

# pynxtools-apm documentation
pynxtools-apm is a free and open-source data software for creating standardized semantic serializations of atom probe tomography and related field-ion microscopy data and metadata for research data management using NeXus, implemented with the goal to make scientific research data FAIR (findable, accessible, interoperable and reusable).

<!-- A single sentence that says what the product is, succinctly and memorably -->
pynxtools-apm, which is a plugin for pynxtools, provides a tool for reading data from various proprietary and open data formats from technology partners of the
atom probe community and standardizing it such that it is compliant with the NeXus application definition NXapm.

<!-- A paragraph of one to three short sentences, that describe what the product does. -->
pynxtools-apm is developed both as a standalone reader and as a tool within NOMAD, which is the open-source research data management platform for Materials Science that is developed by the [FAIRmat consortium of the German National Research Data Infrastructure (German NFDI)](https://www.nfdi.de/consortia-fairmat/?lang=en).

<!-- A third paragraph of similar length, this time explaining what need the product meets -->
pynxtools-apm solves the challenge that comes with using heterogeneous and semantically ambiguous serialization formats that are commonly used in atom probe research. In addition, the plugin provides an interface for writing readers for different file formats to be mapped to NeXus.

pynxtools-apm is useful for scientists from the atom probe community who deal with heterogeneous data, for technology partners, software developers, and data providers who search for ways to make their data more completely aligned with the aims of the FAIR principles.

<!-- A single sentence that says what the product is, succinctly and memorably -->
<!-- A paragraph of one to three short sentences, that describe what the product does. -->
<!-- A third paragraph of similar length, this time explaining what need the product meets -->
<!-- Finally, a paragraph that describes whom the product is useful for. -->

<div markdown="block" class="home-grid">
Expand Down Expand Up @@ -66,3 +73,4 @@ respective file formats of the atom probe tomography and field-ion microscopy co
</div>

<h2>Project and community</h2>
[The work is funded by the Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) – 460197019 (FAIRmat)](https://gepris.dfg.de/gepris/projekt/460197019?language=en).

0 comments on commit adcfd67

Please sign in to comment.