/pmace_jax

An implementation of PMACE framework using JAX

Primary LanguagePythonBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

pmace_jax

An implementation of PMACE framework using JAX

Installing

  1. Clone or download the repository:

    git clone git@github.com:qiuchenzhai/pmace_jax
    
  2. Install the conda environment and package

    1. Option 1: Clean install from dev_scripts

      *****You can skip all other steps if you do a clean install.****

      To do a clean install, use the command:

      cd dev_scripts
      source clean_install_all.sh
      
    2. Option 2: Manual install

      1. Create conda environment:

        Create a new conda environment named pmace_jax using the following commands:

        conda create --name pmace_jax python=3.10
        conda activate pmace_jax
        pip install -r requirements.txt
        

        Anytime you want to use this package, this pmace_jax environment should be activated with the following:

        conda activate pmace_jax
        
      2. Install pmace_jax package:

        Navigate to the main directory pmace_jax/ and run the following:

        pip install .
        

        To allow editing of the package source while using the package, use

        pip install -e .
        

Running Demo(s)

Run any of the available demo scripts with something like the following:

python demo/<demo_file>.py