Installation
The following instructions will let you install two python packages:
ChildProject, the package that is documented here, follow the main installation instructions to get it
DataLad, a python software for the management and delivery of scientific data. Although ChildProject may work without it, a number of datasets of daylong recordings of children require it. We advise to work with it alongside ChildProject. Follow the instructions in the section “Datalad installation” to get it as well.
Note
The default installation procedure requires anaconda. If you are not sure you have conda installed, please do conda --version
.
If you don’t, please refer to the instructions here.
Linux users
# download the conda environment
wget https://raw.githubusercontent.com/LAAC-LSCP/ChildProject/master/env_linux.yml -O env.yml
# create the conda environment
conda env create -f env.yml
# activate the environment (this should be done systematically to use our package)
conda activate childproject
MacOS users
# download the conda environment
curl https://raw.githubusercontent.com/LAAC-LSCP/ChildProject/master/env_macos.yml -o env.yml
# create the conda environment
conda env create -f env.yml
# activate the environment (this should be done systematically to use our package)
conda activate childproject
# install git-annex from brew
brew install git-annex
Note
The ChildProject package alone can also be installed directly through pip, without using conda. However, this means git-annex, ffmpeg, and other dependencies that are not installable through pip will have to be installed by hand.
The following command will install the python package alone via pip and pypi:
pip install ChildProject
Windows users
Warning
ChildProject is only officially supported on Linux and Mac for python >= 3.7. We perform automated, continuous testing on these environments to look for potential issues at any step of the development.
We expect the package to work on Windows, although we do not perform automated tests on this OS at the moment.
If you are on a Windows system, consider using a Windows subsystem for linux (WSL), inside of which you can use all the Linux instructions while accessing your windows filesystem.
- If you which to continue using directly Windows, you must do the following:
Download and run the Git installer found in this page, use the first link in the page. When running the installer, we advise you keep all the default choices.
Download and run the git-annex installer found here, download the file ‘git-annex-installer.exe’ and then launch it, keep everything as default.
Download and run the Miniconda installer, launch the installer and keep all the default options.
Open an Anaconda prompt, after all the installations, you should now have a program called “Anaconda Prompt” in your start Menu, if you can’t find it, use the search field. You will use this program whenever you use ChilProject so it is probably best to pin it to the start menu or create a shortcut on your desktop. Launch it, you should be presented with a terminal window, allowing you to enter and launch commands
Use the following command to download the environment description
# download the conda environment creation info curl https://raw.githubusercontent.com/LAAC-LSCP/ChildProject/master/env_macos.yml -o env.yml
Run this line to create the conda environment, keep the default parameters, this can take several minutes
# create the conda environment, keep the default parameters, this may take a long time conda env create -f env.yml
Activate the childproject environment in your Anaconda Prompt. This must be done everytime you use childproject
# activate the environment (this should be done systematically to use the package) conda activate childproject
Congratulations, You are now able to use all the childproject features inside your Anaconda Prompt.
Datalad installation
This section is optional, it will help you to install Datalad once you have completed the previous step of installing ChildProject.
If you followed the previous instructions correctly, you should have created and activated a conda environment with ChildProject installed. When you are in this environment, run the following:
# install datalad in your environment
pip install datalad
Check the setup
You can now make sure the packages have been successfully installed: Each –version command should output the version of the package
$ child-project --help
usage: child-project [-h] [--version]
{init,validate,import-annotations,automated-import,derive-annotations,merge-annotations,intersect-annotations,interpreter,remove-annotations,rename-annotations,overview,explain,compute-durations,compare-recordings,process,sampler,zooniverse,eaf-builder,anonymize,metrics,metrics-specification,conversations-summary,conversations-specification}
...
positional arguments:
{init,validate,import-annotations,automated-import,derive-annotations,merge-annotations,intersect-annotations,interpreter,remove-annotations,rename-annotations,overview,explain,compute-durations,compare-recordings,process,sampler,zooniverse,eaf-builder,anonymize,metrics,metrics-specification,conversations-summary,conversations-specification}
optional arguments:
-h, --help show this help message and exit
--version displays the current version of the package
$ # run this ONLY IF you have installed the optional software datalad, for getting and sharing data
datalad --version
datalad 0.19.6
Note
We recommend that you regularly keep DataLad and our package up to date.
To force-upgrade this package, do pip uninstall ChildProject
and then pip install ChildProject --upgrade
.
You may also want to install the development version from GitHub in order to receive more recent updates before their release:
pip install git+https://github.com/LAAC-LSCP/ChildProject.git --force-reinstall
Since some updates may break compatibility with previous versions, we advise you to read the Change Log before upgrading.
DataLad can also be upgraded with pip install datalad --upgrade
(see DataLad’s documentation for more details).
Troubleshooting
If you are having trouble installing ChildProject, please look for similar issues on our GithHub (in Issues or Discussions).
If this issue is related to a dependency of the package, we recommend that you ask the developers of the depdendency directly as you may get more accurate advice.
If this issue is related to DataLad, please create an issue on DataLad’s GitHub.
Frequently Asked Questions
I don’t have anaconda and I can’t install it. What should I do?
You should try to install the package inside of a python environment instead, e.g.:
python3 -m venv ~/ChildProjectVenv
source ~/ChildProjectVenv/bin/activate
pip3 install ChildProject
You will still need git-annex in order to use DataLad. It can be installed with brew for Mac users (brew install git-annex) or through apt for Linux users (apt install git-annex). Most likely, you will lack permissions to do so if you failed to install anaconda. In this case, pleaser refer to your system administrator.
``brew install git-annex`` does not work!
Please try brew install --build-from-source git-annex
.
If this does not work better for you, make sure that your version of Mac OS is 10.14 or later. We are aware of issues with Mac OS 10.13 (High Sierra) and earlier.
If your issues persistent, please report it to [DataLad](https://github.com/datalad/datalad).