Check out our user documentation at Read the Docs, and join our new Slack team to stay connected and get quick support!

Ubuntu

See the documentation on adding the official Launchpad PPA. Alternatively, you may also compile from source.

Windows

You may download one of the included zipped archives in the "assets" section (scroll down to find it). Some plugins require a Python interpreter. The following Python versions are supported: 3.5, 3.6, 3.7, and 3.8. Download page: https://www.python.org/downloads/.

If you opt to compile from source, note the additional dependency which you can acquire from apt: zlib1g-dev

Changelog

v0.3.3:

New features:

• You may now export and import simulation results. Relevant documentation is available. This change adds extra dependencies: https://github.com/sebastiandev/zipper and ZLib.

Bug fixes:

• Fixed segfault when loading aggregates either from save file or from simulation results, and streamlined some of the XML loading code.
• Patched a problem with PoisSolver simulation.
• Fixed a segfault where attempting to set screenshot rectangle after opening a save file would lead to a segfault.

Check out our user documentation at Read the Docs, and join our new Slack team to stay connected and get quick support!

Ubuntu

If you are a Ubuntu 18.04 LTS or 20.04 LTS user, you can now get SiQAD from the official PPA on Launchpad!

Ubuntu installation:

sudo add-apt-repository ppa:siqad/ppa
sudo apt-get update
sudo apt-get install siqad

Ubuntu invocation:

siqad

We will add a desktop icon shortcut for Ubuntu in a future release.

Windows

You may download one of the included zipped archives in the "assets" section (scroll down to find it). Some plugins require a Python interpreter. The following Python versions are supported: 3.5, 3.6, 3.7, and 3.8. Download page: https://www.python.org/downloads/.

Changelog

v0.2.2:

General:

• SiQAD version number is now written to save files.
• Saving files now also save the displayed region. The design panel reopens to fit the region at load. Previous implementations attempt to recreate the same zoom and scroll values but was known to be imperfect on different screen sizes.
• Added View menu entry for Zoom in/out/fit and associated shortcuts.
• Fixed a bug in design panel where after using duplication, if the original copy of the items are deleted, future paste events could result in segfault.
• Fixed design panel draft problem on item creation/removal.
• Changed duplication shortcut to Ctrl+D and added shortcut for DBGen (D) and electrode draw (E).
• New icons.

Layer management (major changes):

• Introduced LayerRole dintinguishment between Design (interactive and saves to file), Overlay (interactive and doesn't save to file), and Result (pending implementation, non-interactive and doesn't save to file) layers.
• Added "role" element for layers saving to files.
• Overhauled the layer manager sidebar for improved interactive features and to implement LayerRole distinguishment.
• Implemented most-recently-used layer which was previously disfunctional.
• Creation of objects in incompatible layers is now disallowed.
• Fixed minor state changing bugs that allowed users to create DBs or electrodes in simulation visualization mode when they're not supposed to.

Job visualization (major changes):

• In the past, attempts to load up previous simulation results containing DB layouts which are different from the current design on scene would result in failure. This is now fixed by always loading the simulation design from the simulation problem file when loading a simulation.
• Fixed an issue with the physically valid filter which previously had a high chance of failure; removed the net charge filter due to unresolved bugs and potential confusions when DB+/- states are both present.
• Saving during simulation visualization is now disallowed.

Plugin manager (new):

• Implemented venv support for plugin engines as well as automatic installation of dependencies via pip into venvs.
• Added a Plugin Manager GUI under Tools -> Plugin Manager main for viewing venv initialization status and terminal outputs.

Simulation jobs (major changes):

• Added plugin status indication (mainly to indicate whether a Python-based plugin has finished acquiring pip dependencies) in new job creation panel.
• Updated job termination confirmation message.
• Fixed some cases where job termination didn't work on Windows.
• Updated tmp path generation setting to append user name to the siqad tmp directory to avoid conflicts in multi-user systems.

Screenshot mode:

• Closing screenshot tool dialog now ends screenshot mode.

Compilation, testing, and packaging:

• Removed siqadconn compilation step from the root CMakeLists due to the move to venvs and pip based acquisition of PyPI packages, including siqadconn.
• Initial implementation of compilation-time unit tests.

ExhaustiveGS simulator:

• Now autofails when the problem size is greater than a specific user setting, this is meant to be a sanity check since runtime scales exponentially.

PoisSolver simulator:

• Updated to support newer library versions offered by Ubuntu 20.04 LTS; previously only worked up to Ubuntu 18.04 LTS.

Given the amount of changes introduced here, bumping the version number up to v0.3.0 would have been more appropriate. I had, however, already hard-coded a bunch of comments referring to v0.2.2 so we'll stick with that.

Check out our user documentation at Read the Docs! We have also started a new Slack team for official communications and support, feel free to join us!

Windows Prerequisites

1. Python 3.5, 3.6, 3.7, or 3.8. Download page: https://www.python.org/downloads/.

2. The following Python packages:
   matplotlib numpy scipy pyside2
   For an official Python distribution, you may install them through PIP. For other distributions, such as Anaconda, please refer to their documentations on installing PyPI packages.

Change Log

v0.2.1-hotfix1:

Bug fixes:

• Fixed a crash that occurs when SiQAD GUI crashes upon New document creation when a DB preview dot is on screen.

v0.2.1:

General:

• Removed unimplemented GUI elements.
• Improved screenshot mode tools (scale bar and clip preview) behavior.
• Added screenshot pixels per angstrom setting that can be decoupled from the design panel's default pixel density.

Bug fixes:

• Screenshot mode tools (scale bar and clip preview) activation/deactivation bug fixes.
• Re-implemented full design panel screenshot as it wasn't working before.
• SimVisualizer now initializes into disabled state until a simulation is performed.

Plugins:

• Rewrote ExhaustiveGS in C++
• Updated SimAnneal with general bug fixes and enhancements

Windows deployment:

• Windows 10 binary builds are now moved over to AppVeyor's Visual Studio environment rather than the original cross-compilation.
• Added a Windows portable archive deployment script to automate future Windows builds.

Documentation:

• Added initial Sphinx-based documentation for Read the Doc.

This release accompanies the SiQAD paper acceptance on IEEE Transactions on Nanotechnology. Windows binaries for SiQAD (siqad.exe) and accompanied simulation engines are included in the binary build. For now, Linux and macOS users need to compile from source. Please refer to the project's README documentation on dependencies and compilation steps.

Simulation engines include:

• ExhaustiveGS, which exhaustively searches for the ground state charge configuration;
• SimAnneal, a custom simulated annealing algorithm for fast ground state finding;
• Hopping Dynamics, a charge dynamic simulator; and
• PoisSolver, an electrostatic landscape solver (excluded from Windows builds due to incompatibility).

In the future, we will investigate Windows support for PoisSolver through Docker or Windows Subsystem for Linux.

Windows Prerequisites

1. Python 3.5, 3.6, 3.7, or 3.8. Download page: https://www.python.org/downloads/.

2. The following Python packages:
   matplotlib numpy scipy pyside2
   For an official Python distribution, you may install them through PIP. For other distributions, such as Anaconda, please refer to their documentations on installing Python packages.

This is the first Windows 64 bit binary release for SiQAD. An installer will be included for future releases for but for now, simply extract the archive and run db-sim.exe.

For now, binaries for Linux and macOS are not distributed. Please read the read me on the main page for Linux compilation instructions.

We envision no demands for a 32 bit version but if you need one, please create an issue to let us know.