Документация ASpecD на русском

Добро пожаловать!

Это документация для ASpecD – структуры для обработки спектроскопических данных с упором на воспроизводимость.

Вкратце: каждый шаг обработки, применяемый к вашим данным, будет записан и может быть прослежен. Кроме того, для каждого представления ваших данных (например, рисунков, таблиц) вы сможете легко проследить, как были обработаны представленные данные и откуда они взялись.

Что еще лучше: Фактическая обработка и анализ данных больше не требуют навыков программирования, а сводятся к написанию текстового файла, в котором в упорядоченном виде излагаются все шаги, которые вы хотите выполнить с вашим набором данных.

Интересно? Посмотрите на анализ данных, основанный на готовых решениях, или на следующий пример:

datasets:
  - /path/to/first/dataset
  - /path/to/second/dataset
tasks:
  - kind: processing
    type: BaselineCorrection
    properties:
      parameters:
        kind: polynomial
        order: 0
  - kind: singleplot
    type: SinglePlotter
    properties:
      filename:
        - first-dataset.pdf
        - second-dataset.pdf
Code language: JavaScript (javascript)

Интересует больше реальных примеров? Ознакомьтесь с разделом “Примеры применения”.

Особенности

Список возможностей:

  • Структура для написания приложений, обрабатывающих спектроскопические данные
  • Последовательная обработка числовых данных и соответствующих метаданных
  • История каждого шага обработки, создаваемая автоматически, направленная на полную воспроизводимость
  • Отмена и повтор шагов обработки
  • Импорт и экспорт данных
  • Общие возможности построения графиков, легко расширяемые
  • Формирование отчетов с использованием заранее определенных шаблонов
  • Анализ данных на основе готовых решений, позволяющий выполнять задачи полностью без посторонней помощи в фоновом режиме и без навыков программирования

Чтобы сделать его еще более удобным для пользователей и ориентированным на будущее:

  • Проект с открытым исходным кодом, написанный на Python (>= 3.5)
  • Разработан полностью на основе тестирования
  • Обширная документация для пользователей и API
Внимание! Фреймворк ASpecD в настоящее время находится в стадии активной разработки и все еще считается бета-версией. Поэтому не исключено, что изменения в функциях и публичных API могут нарушить ваш собственный код. Тем не менее, обратная связь, а также запросы о возможностях приветствуются.

Как цитировать

ASpecD является бесплатным программным обеспечением. Однако если вы используете ASpecD для собственных исследований, пожалуйста, приводите соответствующие ссылки:

Till Biskup. ASpecD (2021). doi:10.5281/zenodo.4717937

Чтобы упростить работу, ASpecD имеет DOI, предоставленный Zenodo, вы можете нажать на значок ниже, чтобы получить прямой доступ к записи, связанной с ним.

Обратите внимание, что этот DOI относится к пакету как таковому и всегда перенаправляет на самую актуальную версию.

С чего начать

Пользователям, впервые познакомившимся с ASpecD, лучше начать с самого начала, а те, кто знаком с его основополагающими концепциями, могут сразу перейти к разделу, объясняющему, как писать приложения на основе фреймворка ASpecD.

Если вам интересно, как выглядит работа с фреймворком ASpecD, в частности, анализ данных на основе рецептов, загляните в раздел примеров использования.

Документация по API – это основной источник информации для разработчиков, помимо ознакомления с исходным кодом.

Установка

Чтобы установить фреймворк ASpecD на свой компьютер ( целесообразно в виртуальной среде Python), откройте терминал (активируйте свою виртуальную среду) а затем введите следующее:

pip install aspecd

Ознакомьтесь также с более подробными инструкциями по установке.

Смежные проекты

Существует ряд связанных пакетов, которые основаны на фреймворке ASpecD и каждый из которых фокусируется на одном конкретном типе спектроскопии.

Наиболее развитыми на сегодняшний день являются следующие пакеты:

  • trepr – Пакет для обработки и анализа данных временного электронного парамагнитного резонанса (TREPR), разработанный Дж. Поппом и поддерживаемый Т. Бискупом.
  • cwepr – Пакет для обработки и анализа данных непрерывного электронного парамагнитного резонанса (cw-EPR), первоначально разработанный П. Киршнером, в настоящее время разрабатывается и поддерживается М. Шредером и Т. Бискупом.

Вас также может заинтересовать проект LabInform, направленный на создание необходимой более глобальной инфраструктуры в лаборатории/научной рабочей группе, заинтересованной в более воспроизводимых исследованиях.

Вкратце, LabInform – это “Лабораторная информационная система с открытым исходным кодом”.

Наконец, не забудьте заглянуть на сайт, посвященный воспроизводимым исследованиям и охватывающий более общие сферы воспроизводимых исследований и передовой научной практики.

Лицензия

Эта программа является свободным программным обеспечением: вы можете распространять ее и/или изменять в соответствии с условиями лицензии BSD.

Однако, если вы используете ASpecD для собственных исследований, пожалуйста, приводите соответствующие ссылки.

Замечание по поводу логотипа

Змея (очевидно, питон, посмотрите, как она держит лупу) хорошо знакома с научным методом и иллюстрирует основную идею системы ASpecD: воспроизводимый анализ данных. Авторские права на логотип принадлежат Дж. Поппу.