Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CompatHelper: add new compat entry for StaticArrays at version 1, (keep existing compat) #1

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

CompatHelper: add new compat entry for StaticArrays at version 1, (keep existing compat) #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c11f775
CompatHelper: add new compat entry for StaticArrays at version 1, (ke…
Dec 15, 2021
d875f68
Update README.md
fernandopenaranda Jan 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
VegaLite = "112f6efa-9a02-5b7d-90c0-432ed331239a"

[compat]
StaticArrays = "1"
julia = "1"

[extras]
Expand Down
50 changes: 50 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,53 @@
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://fernandopenaranda.github.io/MBSinBLG.jl/dev)
[![Build Status](https://github.com/fernandopenaranda/MBSinBLG.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/fernandopenaranda/MBSinBLG.jl/actions/workflows/CI.yml?query=branch%3Amain)
[![Coverage](https://codecov.io/gh/fernandopenaranda/MBSinBLG.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/fernandopenaranda/MBSinBLG.jl)

For the sake of reproducibility, we show in this repo: the code, the data files, and the plotting functions used to generate the figures in our work: ref.

Remarks:

0. All the code provided here is written in Julia (v1.0 >)
1. Our code uses the syntax of [Quantica.jl](https://github.com/pablosanjose/Quantica)
2. The data files used to build each figure can be either directly accessed at `MBSinBLG/data` or generated as we illustrate in the following:

## Installation

In a Julia terminal:
```
using Pkg
Pkg.add("https://github.com/fernandopenaranda/MBSinBLG")
```

## Usage

Generate all data corresponding to each figure and store it in a folder named `/data`
```
include("~/MBSinBLG/compute/computefigures.jl")
```
The specifications of the machines used in our calculations are shown in said file.

## Plot

We also provide in `~/MBSinBLG/compute/plotfunctions.jl` the plotting code that generates the figures of our manuscript.
The user just need to specify the path to the .csv file and use the corresponding plotting function, for instance, figure 7 is:
```
using CairoMakie, VegaLite, LaTeXStrings, Colors
using ElectronDisplay
using MBSinBLG
pathfig7 = "MBSinBLG/data/fig7"
fig7plot(pathfig7)

```

## Exported API (additional functions)

In addition, we explicitly export a set of useful functions to obtain information about the physical properties of the system under analysis.
They are the following:
```
nanoribbonS, nanoribbonSA, nanoribbonSZ, Params, modelS, rectangle_weaklink, rectangle_randombounds_sc, ldosonlattice_averaged_sc
```
Detailed information on any of them can be accessed as follows: `?function_name`