Skip to content

Rename ADAM to AIDAS (Argonne AI-Driven Adaptive Sampling System) - #30

Merged
rcjackson merged 3 commits into
mainfrom
rename-to-aidas
Sep 15, 2026
Merged

rcjackson merged 3 commits into
mainfrom
rename-to-aidas

Conversation

@rcjackson

Copy link
Copy Markdown
Owner

No description provided.

Robert Jackson and others added 2 commits September 15, 2026 12:50
Rename the import package from `adam` to `aidas` and the PyPI distribution
from `adam-atmos` to `aidas-atmos`, and retitle the project from "ATMOS
Analogue Digital Twin" to the "Argonne AI-Driven Adaptive Sampling System".

PyPI distribution names cannot be renamed in place, so `adam-atmos` lives on
as a separate, transitional project under compat/adam-atmos/. That shim has no
functionality of its own: it depends on `aidas-atmos>=0.6.0` and aliases every
`aidas.*` module under the old `adam.*` prefix, so existing code keeps working
and gets a DeprecationWarning pointing at the new name. It is built and
published independently of the root project.

Also in this change:

* Replace the "digital twin" framing in the project description with adaptive
  sampling / instrument tasking, which is what the system actually does: it
  models the atmosphere and cues instruments, it does not model an instrument.
* Rewrite the README, whose three badges pointed at an unrelated `adam` project
  on PyPI, a readthedocs site that is not ours, and a pyup shield.
* Point the changelog URL at the rendered history page rather than a
  changelog.md that does not exist on a master branch that does not exist, and
  add documentation/repository URLs.
* Add a migration section to the installation docs.
* Bump the version to 0.6.0.

Historical changelog entries keep their wording, but their :func:/:mod: roles
now point at `aidas.*` so they resolve in the rendered docs. The 0.1.1 entry
recording the original rename to `adam-atmos` is left verbatim.

Phase 4 housekeeping: add CITATION.cff (BSD-3-Clause, the five authors from
`__author__`) and ship it in the sdist.

Co-Authored-By: Claude Opus 5 (1M context) <[email protected]>
main bumped the version to 0.6.0 for the gate geolocation work, so that
release now carries both it and the rename. The changelog only listed the
rename.

Co-Authored-By: Claude Opus 5 (1M context) <[email protected]>
Renaming ADAM to AIDAS lengthened three titles by a character each while
leaving their underlines at the old width, which docutils reports as
"Title underline too short" and the -W docs build turns into an error:

* docs/source/index.rst - the page title grew by 16 characters.
* examples/README.txt - sphinx-gallery copies this into the generated
  auto_examples/index.rst, which is where CI reported it.
* src/aidas/testing/__init__.py - the module docstring's overline and
  underline, pulled in by autodoc.

Verified with a local `sphinx-build -W --keep-going` (gallery execution
disabled): build succeeded, no warnings.

Co-Authored-By: Claude Opus 5 (1M context) <[email protected]>
@rcjackson
rcjackson merged commit 4e6ae5b into main Sep 15, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant