Skip to content
FriendsofECCEPublic

About

ECCE, the Extensible Computational Chemistry Environment: build molecules, set up and run NWChem, Gaussian, ORCA and MOPAC calculations on a workstation or cluster, and view the results. Linux, Windows and macOS. Originally developed at PNNL.

Topics

Resources

Code of conduct

Contributing

Security policy

Accessibility

Stars

12 stars

Watchers

6 watching

Forks

Latest commit

 

History

5,535 Commits

Folders and files

ECCE

DOI

The Extensible Computational Chemistry Environment (ECCE, pronounced "etch-ā"; ecce is Latin for "behold") is a graphical environment for computational chemistry: build a molecule, set up a calculation, run it on your own computer or a cluster, and look at the results (orbitals, densities, vibrations, geometry optimisations), with every calculation kept in one place.

It works with ORCA, Gaussian, NWChem, MOPAC and xTB, and experimentally with GROMACS, CP2K and Quantum ESPRESSO; ECCE 9 also includes ECCE-QM, a small built-in Hartree–Fock/DFT program that needs nothing else installed. Calculations can be chained into workflows: for example, xTB finds a structure quickly and ORCA refines it, each step starting from the geometry of the one before. ECCE was developed at Pacific Northwest National Laboratory, which stopped supporting it around 2017; it is maintained here since, with PNNL's blessing.

The Organizer: the Examples project tree and the Progress box of a finished ORCA optimisation and frequency calculation on ethylene, with SCF and optimisation plots The viewer showing the pi orbital of ethene on a white background, with the Properties list and the MO table

More pictures and the full feature list: ECCE overview.

Get ECCE

Download from the releases page.

  • ECCE 9 (latest 9.5.2), for Linux, macOS and Windows: the recommended version. The macOS and Windows clients are experimental.
  • ECCE 8.18.x (latest 8.18.14), Linux only: the older line, which still gets bug fixes.
System File Install
Debian 13, Ubuntu 24.04 ecce-client_…deb, ecce-server_…deb sudo apt install ./ecce-client_*.deb ./ecce-server_*.deb
RHEL/Rocky 9, Fedora ecce-client-…rpm, ecce-server-…rpm sudo dnf install ./ecce-*.rpm (on RHEL/Rocky first sudo dnf install epel-release)
macOS ECCE-…-arm64.dmg (Apple silicon) or …-x86_64.dmg (Intel, macOS 10.15 or later) or …-x86_64-macos10.13.dmg (Intel, macOS 10.13 and 10.14; experimental) open it and drag ECCE to Applications; macOS refuses it at first: on macOS 15 and later open it once, then System Settings → Privacy & Security → Open Anyway (macOS 14 and earlier: right-click → Open), or run xattr -dr com.apple.quarantine /Applications/ECCE.app
Windows 10/11 ECCE-windows-….msi double-click; at the SmartScreen warning choose More info → Run anyway

Then start ecce (on macOS and Windows: ECCE in Applications or the Start menu). Details for each system: Installing ECCE.

Coming in 9.6.0

On main, not in a package yet:

  • Windows: local sessions use a small message broker inside ECCE instead of mosquitto.exe, as in 9.4.15; ECCE_BROKER=mosquitto keeps the old route (#990).
  • Linux and macOS: local sessions use the same broker (a small program, eccebroker) instead of a per-user mosquitto, so a client needs no mosquitto. A central server and a shared system broker still use Mosquitto, unchanged; ECCE_BROKER=mosquitto keeps the old local route (#1007).
  • General Chemistry examples: a new topic, Molecular and covalent solids, with seven Quantum ESPRESSO crystals (ice, dry ice, urea, benzene, sucrose, diamond, graphite), each with its powder pattern.
  • Edit > Preferences > Codes chooses which codes are offered for new calculations; hidden codes stay listed as "N more codes (hidden)..." (#1049).
  • New from This > Rerun, Continue from Last Geometry, Continue from Final Orbitals and Continue in Another Code..., the same names in the Edit and right-click menus.
  • Diffraction as a docked Properties pane; thermochemistry split into translation, rotation, vibration and electronic contributions, with C_V and C_P; a GROMACS calculation from your own .mdp/.gro/.top or .tpr files (#1038); MACE as a workflow step (#1019).
  • One program with tabs on Windows, macOS and Linux (#983) is the default (#1067): Organizer, Builder, Calculation Editor and the other tools are tabs of one window. ECCE_ONE_PROCESS=0 ecce brings back one window per tool.

First steps

The same pages are in ECCE under Help. To see it done first, the chem4eva YouTube channel has short videos with subtitles: installing ECCE, a first calculation with ECCE-QM (nothing else to install) and a first ORCA calculation.

  1. Installation: what you see the first time ECCE starts, and where your work is kept.
  2. Your first calculation: build, run and look at a calculation.
  3. Running codes on Linux, on Windows or on macOS: installing NWChem, MOPAC, ORCA and the others, and telling ECCE where they are.
  4. Importing a structure or a calculation that ran elsewhere.
  5. Scripting and AI assistants: the command-line tools and the AGENTS.md file that says how to work with ECCE's data.

Getting help and reporting a problem

Questions, and how you use ECCE, are welcome in Discussions. Run the session that goes wrong with ecce --bug. When it ends, ECCE collects its logs into ~/ecce-bug-<time>.zip (no passwords, but host names, user names and paths). Attach that to a new issue, with what you did and what you expected.

For administrators and developers

  • Getting started: building, packaging, a central server for a group or class, TLS, the other deployment modes, upgrading from 8.x.
  • Contributing: building from source, branches and releases, the roadmap, and how to help.
  • Changes: what is new in 9.0 and in 8.x, and the release history.
  • The wiki: where things are in the code, and the current work plan.
  • Accessibility: what ECCE does for keyboard, screen reader and low-vision use, and how to report a barrier.

Citing ECCE

Please cite the DOI for all versions, 10.5281/zenodo.23281771; each release also has its own DOI there. GitHub's "Cite this repository" button gives the reference in APA and BibTeX form.

License

ECCE is free software under the Educational Community License 2.0; see LICENSE. For the use of the name, see TRADEMARKS.md.

About

ECCE, the Extensible Computational Chemistry Environment: build molecules, set up and run NWChem, Gaussian, ORCA and MOPAC calculations on a workstation or cluster, and view the results. Linux, Windows and macOS. Originally developed at PNNL.

Topics

Resources

Code of conduct

Contributing

Security policy

Accessibility

Stars

12 stars

Watchers

6 watching

Forks

Releases

Packages

Contributors

Languages