Welcome to the Open ResearchNotes’ documentation.

Open ResearchNotes is an electronic lab notebook (ELN) to keep track of your experiments/samples/simulations, procedures/processing/measurements and results. Unlike your handwritten lab book, it is organized by samples - which are understood of the entity you are investigations. All procedures, measurements and results are connected to the sample, keeping things in a logical order and not distributed over various places. Further, it has a place for your general documentation (as a wiki), a dedicated machine/setup logging and finally an item inventory to keep track of your stuff.

The source code is available on gitlab.

gitlab_url:

https://gitlab.com/lcpm/researchnotes.

Features

• Organization of the research data by samples (ESS entries), to which measurements (PPM entries) and reports are connected.

• ESS entries have identifiers and description to provide metadata to attached files and to physical samples. We also have extra fields to mark for ESS origin, creator and creation place. We track creation and update times for you. These entries can be ordered and searched to find data or samples information.

• Indexing against a full text search engine (ElasticSearch or Meilisearch) allowing to search the long description and other relevant fields.

• Users are organized by research groups and can have either the role of a student or supervisors. On leaving the group, the student account is converted into a former student account and data shared with the supervisor.

• Easy upload of files. For various file types, a preview function is implemented.

• Long description text for the ESS, PPM and report entries can be formatted and translated to HTML using Markdown. A Markdown toolbar is implemented to help to learn the commands. The Markdown can refer to uploaded images.

• A documentation wiki using Markdown as to format and creation of new documents containing information not directly connected to samples (e.g. experimental protocols, common procedures etc.). Documents are shared and editable on the group bases.

• ESS entries can be shared between persons with an account in the software allowing collaboration and collection of research data form different sources in one entry.

• ESS location can be marked and used to track the location of a sample.

• ESS entries are exportable to Markdown files for storage and backup outside the software.

• A dedicated instrumentation journal exist that allows tracking the status, changes or information of setups used for measurements that are not directly related to ESS. Instruments are managed at the group level and can be shared to other users to keep information coherent.

• Item inventory to keep track of things like equipment, chemicals and things belonging to a group. Items have location and can be checked out by group members. Besides this, we have dedicated fields for vendors and catalog numbers as well as a free long description where you can store further information. Files can be attached to the item.

User documentation

• 1. Overview
  • 1.1. Samples, Measurements and other stuff
  • 1.2. Documentation
  • 1.3. Instruments
    • 1.3.1. Instrument
    • 1.3.2. Journal entry
  • 1.4. Inventory
  • 1.5. Roles available in ResearchNotes
  • 1.6. Limitations
• 2. Installation and configuration
  • 2.1. Configuration of ResearchNotes
  • 2.2. Config file
  • 2.3. Commandline and other administrative task
  • 2.4. Search engine
• 3. Experiment/Sample/Simulation entry
  • 3.1. Create a ESS entry
  • 3.2. Editing EES entry
  • 3.3. Template icon
  • 3.4. Summarize (export your ESS information)
  • 3.5. New P/P/M
  • 3.6. Share E/S/S with
  • 3.7. E/S/S is at
  • 3.8. Dropzone
  • 3.9. Associated Procedures/Processing/Measurements
  • 3.10. Associated Files
• 4. ESS menu and view
  • 4.1. All E/S/S
  • 4.2. Shared ESS
  • 4.3. Group ESS (Supervisor role only)
  • 4.4. All P/P/M
  • 4.5. Templates
  • 4.6. Sample series
• 5. Processing/Procedure/Measurement entry
  • 5.1. Add PPM
  • 5.2. Return to ESS
  • 5.3. Edit
  • 5.4. Template
  • 5.5. New report
  • 5.6. Associated Reports
  • 5.7. Associated Files
• 6. Report entries
  • 6.1. Create report
  • 6.2. Return ESS
  • 6.3. Return PPM
  • 6.4. Edit
  • 6.5. Associated Files
• 7. Documents
  • 7.1. Document creation form
  • 7.2. Edit
  • 7.3. Download
  • 7.4. Delete
  • 7.5. Overview
• 8. Instruments
  • 8.1. New instrument
  • 8.2. Instrument view
  • 8.3. Editing instrumentation
  • 8.4. Deactivating an instrument
• 9. Journal entry overview
  • 9.1. New Journal Entry
  • 9.2. Journal Entry
• 10. Inventory
  • 10.1. New item
  • 10.2. New item type
  • 10.3. Templates
• 11. Searching
• 12. Additional menu points
  • 12.1. Markdown in text areas
  • 12.2. Settings and User info
    • 12.2.1. New PPM type (supervisor)
    • 12.2.2. New location (supervisor)
    • 12.2.3. New user (supervisor and admin)
    • 12.2.4. Groups (admins)
    • 12.2.5. App info (admins)

Code documentation

• Open ResearchNote code remarks
• ResearchNotes
  • ResearchNotes package
    • Subpackages
    • Submodules
    • ResearchNotes.app_configuration module
    • ResearchNotes.auth module
    • ResearchNotes.cli module
    • ResearchNotes.documents module
    • ResearchNotes.entry module
    • ResearchNotes.error module
    • ResearchNotes.files module
    • ResearchNotes.htmx module
    • ResearchNotes.instruments module
    • ResearchNotes.inventory module
    • ResearchNotes.locations module
    • ResearchNotes.main module
    • ResearchNotes.measurement module
    • ResearchNotes.notification module
    • ResearchNotes.preview module
    • ResearchNotes.report module
    • ResearchNotes.rn_class module
    • ResearchNotes.samples module
    • ResearchNotes.search module
    • ResearchNotes.setup module
    • ResearchNotes.template module
    • ResearchNotes.type_management module
    • ResearchNotes.url_security module
    • ResearchNotes.util module
    • ResearchNotes.well_known module

Indices and tables ==================df

• Index