Skip to main content

Readable Science Markup (RSM)

tests docs

The web-first authoring software for scientific manuscripts. Part of Aris: the open research stack.

RSM is a suite of tools that aims to change the way scientific manuscripts are published and shared using modern web technology. Currently, most scientific publications are made with LaTeX and published in PDF format. While the capabilities of LaTeX and related software are undeniable, there are many pitfalls. RSM aims to cover this gap by allowing authors to create web-first manuscripts that enjoy the benefits of the modern web.

One of the main aims of the RSM suite is to provide scientists with tools to author scientific manuscripts in a format that is web-ready in a transparent, native way that is both easy to use and easy to learn. In particular, RSM is a suite of tools that allow the user to write a plain text file (in a special .rsm format) and convert the file into a web page (i.e. a set of .html, .css, and .js files). These files can then be opened natively by any web browser on any device.

Distill showed what web-native scholarship could be. RSM makes it accessible to everyone.

Installation

Install RSM globally without polluting your system Python:

pipx install rsm-lang
rsm --version

Why pipx?

  • Installs rsm command globally
  • Isolated environment (no dependency conflicts)
  • Works on macOS, Linux, and Windows

Alternative: uvx (Zero Install, Run on Demand)

Run RSM without installing anything:

uvx --from rsm-lang rsm build paper.rsm

Why uvx?

  • No installation required
  • Always uses latest version
  • Automatically manages dependencies

Traditional: pip (System Python)

pip install rsm-lang

Note: Use the above tools or a virtual environment for a cleaner setup.

Contributing

This project is under constant development and contributions are very much welcome! Please develop your feature or fix in a branch and submit a PR.

Rebuilding the Standalone JS Bundle

The file rsm/static/rsm-standalone.js is a pre-built bundle of all RSM JavaScript for standalone HTML files (files that can be opened directly from file:// URLs).

If you modify any JS files in rsm/static/, you must regenerate this bundle:

npx esbuild rsm/static/onload.js --bundle --format=iife --global-name=RSM --outfile=rsm/static/rsm-standalone.js

This bundles onload.js and all its dependencies into a single IIFE that exposes RSM.onload() and RSM.onrender(). The bundle is committed to the repo so there's no runtime dependency on esbuild.

Development Setup

Prerequisites

  • Python 3.10 or higher
  • uv - Fast Python package installer
  • just - Command runner

Installation

Install uv

# macOS/Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

# Or with pip
pip install uv

Install just

# macOS
brew install just

# Linux
cargo install just

# Windows
scoop install just

Clone and install rsm-lang

git clone --recurse-submodules https://github.com/leotrs/rsm.git
cd rsm
just install

This installs:

  • rsm-lang in editable mode (you can modify the code)
  • tree-sitter-rsm from PyPI as a pre-built wheel (compiled grammar)
  • All development and documentation dependencies

Note: The tree-sitter-rsm grammar is installed from PyPI with platform-specific pre-built binaries. You don't need to build anything unless you're modifying the grammar itself.

Common Tasks

just                  # List all available commands
just test             # Run fast tests
just test-all         # Run all tests including slow ones
just lint             # Format code and run linter
just check            # Run lint + tests (quality gate)
just docs-serve       # Serve docs with live reload

Grammar Development

Most developers don't need this. Only use these steps if you're modifying the tree-sitter grammar in tree-sitter-rsm/grammar.js.

# Install tree-sitter-rsm in editable mode (overrides PyPI version)
just install-local

# After modifying grammar.js in tree-sitter-rsm/
just build-grammar

The difference between just install and just install-local:

Command tree-sitter-rsm source Editable? Use when
just install PyPI wheel No Developing rsm-lang code (most common)
just install-local Local submodule Yes Modifying the grammar itself

Metadata

Release files for rsm-lang 1.5.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for rsm-lang 1.5.2
File Size Uploaded Provenance Actions
rsm_lang-1.5.2.tar.gz 454.0 kB Without provenance Details for rsm_lang-1.5.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for rsm-lang 1.5.2
File Interpreter ABI Platform Actions
rsm_lang-1.5.2-py3-none-any.whl Python 3 none any Details for rsm_lang-1.5.2-py3-none-any.whl

Total release size: 858.2 kB

Release files / rsm_lang-1.5.2.tar.gz

Download URL rsm_lang-1.5.2.tar.gz
Size 454.0 kB
Tags Source
SHA-256 checksum
How to use checksums
708c5f62fdf37b979d1f1573e670ca15a6604f7cdb8d24e9e41f58feeed7f0bd
BLAKE2b-256 checksum
How to use checksums
7130bd87a2444ead356f71c1dc2e5f10ca41b49924526e3ae1bb697f814df71a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.23 {"installer":{"name":"uv","version":"0.12.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / rsm_lang-1.5.2-py3-none-any.whl

Download URL rsm_lang-1.5.2-py3-none-any.whl
Size 404.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8ca82a1f0b09e90b2807d0925f0a539d7ae24db68285320a10257e86bb75c2bb
BLAKE2b-256 checksum
How to use checksums
b2afb4b3b2dc542690973be370e8b6eda9b23bcedad8e9b76c9c3273a988d5ac
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.23 {"installer":{"name":"uv","version":"0.12.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for rsm-lang 1.5.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page