Commit 7d7c3dc1 authored by Zhang, Chen's avatar Zhang, Chen
Browse files

update readme

parent b67d0a17
Loading
Loading
Loading
Loading
+28 −0
Original line number Diff line number Diff line
# Transformer Graph Nueral Network for Reflectometry Data Analysis Toolkits

This repository holds various neural-netowrk based (primarily GNN and transformer) tool-kits developed for the neutron reflectometry techniques.

## Setup and Installation

1. Please use provided environment file to setup `conda` environment for this repository.

    ```bash
    conda env create -f environment.yml
    ```

    > for mac, please use `environment_mac.yml` instead.

2. Activate the environment

    ```bash
    conda activate tgreft_dev
    ```

3. Perform editable install.

    ```bash
    pip install -e .
    ```

## Usage

Although you can run the scripts and notebook anyway, it is highly recommended to a different workspace such as a `workspace`.