Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:

- name: Build docs
run: |
sphinx-apidoc -o docs/source/apidoc beam
sphinx-apidoc -o docs/source/apidoc datatractor_beam
sphinx-build -b html docs/source/ public/main

- name: Upload docs artifact
Expand Down
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,14 @@
Repository containing the reference implementation of the Datatractor API, published at [![Datatractor Yard](https://badgen.net/static/%F0%9F%9A%9Cdatatractor/yard)](https://yard.datatractor.org/).


For more information, see the preprint:
For more information, see the publication:

> **Datatractor: Metadata, automation, and registries for extractor interoperability in the chemical and materials sciences**
> Matthew L. Evans, Gian-Marco Rignanese, David Elbert & Peter Kraus
> MRS Bulletin, 50, 838-845 (2025) [DOI: 10.1557/s43577-025-00925-8](https://link.springer.com/article/10.1557/s43577-025-00925-8)


or preprint at:

> **Datatractor: Metadata, automation, and registries for extractor interoperability in the chemical and materials sciences**
> Matthew L. Evans, Gian-Marco Rignanese, David Elbert & Peter Kraus
Expand All @@ -41,7 +48,7 @@ pip install .
### Usage

#### As a Python module
To extract data from a file, you can use the `extract` function from the `beam` module inside your own Python code:
To extract data from a file, you can use the `extract` function from the `datatractor_beam` module inside your own Python code:

```python
from datatractor_beam import extract
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
import os
import sys

sys.path.insert(0, os.path.abspath(os.path.join("..", "..", "beam")))
sys.path.insert(0, os.path.abspath(os.path.join("..", "..", "datatractor_beam")))

version = "main"

Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Datatractor Beam: Reference implementation of the Datatractor API
:hidden:
:glob:

apidoc/beam
apidoc/datatractor_beam


Documentation of |beamrepo|_, the reference implementation of the Datatractor API,
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ source = "vcs"
version-file = "_version.py"

[tool.hatch.build.targets.wheel]
packages = ["beam"]
packages = ["datatractor_beam"]

[project]
name = "datatractor-beam"
Expand Down Expand Up @@ -57,7 +57,7 @@ dev = [
repository = "https://github.com/datatractor/beam"

[project.scripts]
datatractor = "beam:run_datatractor"
datatractor = "datatractor_beam:run_datatractor"

[tool.ruff]
extend-exclude = [
Expand Down
2 changes: 1 addition & 1 deletion scripts/biologic-mpr-example.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import pathlib
import urllib.request

from beam import extract
from datatractor_beam import extract

# Download an example MPR file from the registry
download_path = pathlib.Path(__file__).parent / "data" / "example.mpr"
Expand Down
2 changes: 1 addition & 1 deletion tests/test_mpr.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

import pytest

from beam import ExtractorPlan, SupportedExecutionMethod, extract
from datatractor_beam import ExtractorPlan, SupportedExecutionMethod, extract


@pytest.fixture
Expand Down