https://github.com/anushapb/frame

https://github.com/anushapb/frame

Science Score: 23.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
  • .zenodo.json file
  • DOI references
    Found 1 DOI reference(s) in README
  • Academic publication links
    Links to: wiley.com
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.1%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: AnushaPB
  • License: mit
  • Language: Jupyter Notebook
  • Default Branch: main
  • Size: 55.6 MB
Statistics
  • Stars: 0
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Fork of ShenHaotv/frame
Created 11 months ago · Last pushed 11 months ago

https://github.com/AnushaPB/frame/blob/main/


# frame

**F**ine **R**esolution **A**symmetric **M**igration **E**stimation (`frame`) is a python package 
implementing a statistical method for inferring and visualizing asymmetric gene-flow in 
spatial population genetic data.

The `frame` method and software was developed by Hao Shen and advised by John Novembre. The structure of project was adapted from feems https://github.com/NovembreLab/feems.git. We also used code from Benjamin M. Peter to help construct the spatial graphs. 
 
We recommend that users install [Anaconda][anaconda] or [Miniconda][miniconda] to prioritize the MKL-optimized versions of numerical libraries such as ```numpy```, ```scipy```, and others. This is crucial for ensuring the numerical performance of our method. 
To get started, set up a new conda environment, make sure that ```defaults``` is the only channel:

```
conda create -n=frame-e python=3.11.9
conda activate frame-e
```
Note: For Mac M1 users they'll need to add `--platform=osx-arm64` to the conda create command. 

The dependencies are listed in dependencies.txt. We recommend installing packages using `conda` in the following sequence to avoid conflicts in packages:

```
conda install numpy==1.26.4 scipy==1.11.4 scikit-learn==1.5.1
conda install pytest==8.3.4 pyproj==3.6.1
conda install matplotlib==3.10.0 click==8.1.8 fiona==1.10.1
conda install cartopy==0.24.1 networkx==3.4.2
```
Once the conda environment has been setup with these dependencies we can install `frame`:

```

pip install git+https://github.com/shenhaotv/frame

```

# Running frame

To help get your analysis started, we provide an example workflow in the [Example.ipynb](https://github.com/ShenHaotv/frame/blob/main/docsrc/Example.ipynb) notebook. The notebook analyzes empirical data from North American gray wolves populations published in [Schweizer et al. 2015](https://onlinelibrary.wiley.com/doi/full/10.1111/mec.13364?casa_token=idW0quVPOU0AAAAA:o_ll85b8rDbnW3GtgVeeBUB4oDepm9hQW3Y445HI84LC5itXsiH9dGO-QYGPMsuz0b_7eNkRp8Mf6tlW). 

[anaconda]: https://www.anaconda.com/products/distribution
[miniconda]: https://docs.conda.io

Owner

  • Name: Anusha Bishop
  • Login: AnushaPB
  • Kind: user
  • Company: UC Berkeley

GitHub Events

Total
  • Push event: 2
Last Year
  • Push event: 2