Alpha testing
Thank you for trying Ingence. This is an alpha, version 0.4.0. You can use it from install to results, and it will change. This page covers installing, what to try, what to tell us and the limits of this version.
Ingence shows what is in your folders, how the experiments connect, which ones repeat and which are complete. It runs on your computer. Ingence never changes your files.
1. Install
Ingence needs Python 3.12, 3.13 or 3.14, on macOS, Windows or Linux. Install it, then check that it worked:
uv tool install ingence
ingence --version
uv tool install gets a supported Python for you if you do not have one. To install with pipx,
pip or conda, or from a wheel file someone gave you, see Install.
ingence --version prints the version (0.4.0) and the build it came from. Please include
that line in anything you send us. To update from an earlier version, run
uv tool upgrade ingence.
2. Try the demo
ingence demo
This makes a small invented laboratory in a new folder called ingence-demo. It scans it and opens
the Dashboard in your browser. The Dashboard runs on your computer only, at an address that starts
with http://127.0.0.1. Press Ctrl-C in the terminal to stop it.
The demo’s files are invented, so look at what Ingence shows, and do not judge whether it is right.
Press ? for the keyboard shortcuts.
3. Try it on a folder of your own
Pick a folder you know well, such as the data of one project. Then type:
ingence
The landing page asks for the data folder, a project name and where to save the project (Add a folder). Save the project on your own disk, outside the data folder. Choose a reading depth: Quick, Standard or Deep (Reading depth). Standard is the default. Then press Start scan. The page shows what it has found so far, and opens the Dashboard when the scan ends.
To stop a scan, press Stop. The page says what Ingence keeps.
Ingence only reads your data folder. It saves everything in the project folder you chose.
4. What to look at
Overview: the summary, your areas, how complete your experiments are and what Ingence assumed. Does it match what you remember doing? If an assumption is wrong, press This is wrong.
Overlap: how experiments connect. Try Connections and By year.
Experiments: each experiment with its raw data and analysis. Open one to read its story.
Checks: the questions Ingence asks you. Answer a few, then press Re-run and see what changes.
History: every scan of the project.
Advanced: the rules and the Dictionary of words Ingence knows. Is a word from your field missing?
5. Limits in this version
Rules. Some rules that ship with Ingence cannot run yet.
ingence infersays how many, andingence infer --verboselists them.De-identified export. Ingence can’t yet write what it builds over a real folder with the names replaced. This export is planned.
Options. Commands and their options can still change.
Older versions. 0.3.3 cannot open a project that 0.4.0 has scanned (Upgrading a project).
6. Five questions to help development
Did the install and the demo work with the steps on this page? If not, where did you stop?
On your own folder, did Ingence group files into experiments the way you would? Please send examples of experiments it found well.
Which pages, buttons or words were hard to understand?
What would make you use it again next week?
What would you like Ingence to do that it does not do yet?
7. How to report a problem
Open a new issue on GitHub. Report a problem, at the bottom of the Dashboard, writes the versions and counts for you, and nothing from your data. Read it, press Copy the text instead and paste it into the issue. Or write the issue yourself, and include:
the output of
ingence --version;your operating system and browser;
what you did, what you expected, and what happened;
the output of
ingence fix --shareable -p <your project>. It writes the project, each data folder and each scan as a stand-in, such as<root 1>.
Reporting a problem says what else helps, and what not to post.
Questions and feedback
Send your answers to the questions above, or anything else, to the discussions on GitHub. A problem goes in an issue. Andrew Bazley, who makes Ingence, reads both.