Skip to content

Welcome !

Welcome on the documentation website of the material science database (msdb) python package: an open source and FAIR database framework for the analyses of materials. You will find on this website information and tutorials on how to install and use the msdb package.

New users

If you are a new user, look at the Get started section. It provides all the basic information you need to know about the package.

Contributions

We are welcoming any contributions, comments (positive and negative), ideas, etc. This is important to improve the quality of the package and its documentation. If you have encountered a bug or spotted an error, please don't hesitate to contact us by email (see below).

Contacts

Email: microfading@mailo.com

What is this package about ?

This package has been designed for users that perform scientific analyses on materials. It aims to provide a generic working environment that can be used to store information about the objects, the materials, the analytical methods, the users, etc. The idea is to have a central location - a folder on your computer - that contains several databases files (.txt and .csv files) from which information can be easily retrieved and connected to analytical data. This package aims to support the creation and management of such database environment.

What does this package provide ?

The package provides two main resources:

  • database files: create txt and csv files to store any relevant information regarding your analytical tasks.

  • CRUD functions: a set of functions to create, read, update, and delete the content of the database files.

Website structure

The documentation follows the structure described by Daniele Procida, which organizes documentation into four different groups (Tutorials, How-to, Explanations, References).

Cite package

If you are using this package for a publication, please cite the package as follows: