Package: odML-UI
odML EditorThe odML-Editor is a standalone GUI application used for working with the odML Documents.
The Python odML library is available onGitHub.
If you are not familiar with the version control systemgit, but still want to use it,
have a look at the documentation available on thegit-scm website.Breaking changesodML Version 1.4 introduced breaking format and API changes compared to the previous
versions of odML. Files saved in a previous format version can be automatically
converted into the new format via "File - Import". The import will create a new file
and will not overwrite the original file.Be aware that the value dtypebinaryhas been removed. Incorporating binary
data into odML files is discouraged, provide references to the original files using theURLdtype instead.For details regarding the introduced changes please check thegithub release notes.Release VersionsAll released versions are distributed via thePython Package Indexand can be installed usingpip:pip install odml-uiOnce installed, the program can be activated via the command line:odmluiNote: It might be required to install the external GTK3 dependencies first.DependenciesThe odML-Editor makes use of the Gtk 3+ library for the GUI, and thepython-odmllibrary. The following dependencies need to be installed
for the odML-Editor.Python 2.7+ or Python 3.4+odml v1.4(pip install odml)For Ubuntu-based distributionssudo apt-get install libgtk-3-0sudo apt-get install gobject-introspectionFor Python 3,sudo apt-get install python3-giFor Python 2,sudo apt-get install python-giFor Fedora-based distributionssudo dnf install gtk3sudo dnf install pygobject3For Python 3,sudo dnf install python3-gobjectFor Python 2,sudo dnf install python-gobjectAnaconda DependenciesAnaconda environments require only the following packages before installing the odML-Editor:Python 2.7+ or Python 3.4+.Install the following packages in the following order:conda install -c pkgw/label/superseded gtk3
  conda install -c conda-forge pygobject
  conda install -c conda-forge gdk-pixbuf
  conda install -c pkgw-forge adwaita-icon-themeNOTE: These packages currently only work on Linux out of the box!The macOS installation of these 3rd party dependencies contain a bug which causes
the opening of any window selecting files to crash the application.If you still want to use odmlui with conda on macOS, you currently need to
apply a manual fix at the start of your session in your active conda environment
to avert this crash:export GSETTINGS_SCHEMA_DIR=$CONDA_PREFIX/share/glib-2.0/schemasYou can also add scripts to your conda environment that always automatically sets up the
required environment variable at the start of a conda session as described in theconda documentation.macOS using homebrewFor Python 2 (Python 3)brew install gtk+ (gtk+3)brew install pygobject (pygobject3)brew install gnome-icon-themebrew install gobject-introspectionWindows with AnacondaDependenciesPyGObject for Windows(tested with 3.24.1rev1)Python 2.7+odml v1.4+(pip install odml)InstallationInstall AnacondaCreate a new environment with Python 2.7+InstallPyGObjectfor Windows - base package and GTK+ 3.18.9 packageSelect portable Python installation -> add path to virtual env Python default:
C:\Users\userName\Anacaonda\envs\nameOfEnv\Start Anaconda promptinstall odml(pip install odml)install odml-ui(python setup.py install)run with(odmlui)Windows WarningWindows of odml-ui cannot be moved (only maximized) - movement or resize of the windows
crashes the application.Installation from sourceThe most straightforward way to get to the odML-Editor source from
the command line is to use git and clone the repository from GitHub
into your directory of choice:cd /home/usr/toolbox/
git clone https://github.com/G-Node/odml-ui.gitIf you don't want to use git, download the ZIP file also provided on
GitHub to your computer (e.g. as above on your home directory under a "toolbox" folder).To install the odML-Editor, enter the corresponding directory and run:cd /home/usr/toolbox/odml-ui/
python setup.py installNote:pip install giwill lead to a namespace conflict with the
required GObject introspection library.DocumentationMore information about the project including related projects as well as tutorials and
examples can be found at ourodML project page.Bugs & QuestionsShould you find a behaviour that is likely a bug or feel there is something missing,
just create an issue over at the GitHubodML-Editor issue tracker.