Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
kongdd committed Jan 16, 2024
1 parent 16154fb commit 0879f5b
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 19 deletions.
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "BEPS"
uuid = "28258c4d-138d-4793-867a-264e32c782b1"
authors = ["Dongdong Kong <[email protected]>"]
version = "0.1.2"
version = "0.1.3"

[deps]
DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
Expand Down
35 changes: 18 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,38 @@
# BEPS.jl

<!-- [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://CUG-hydro.github.io/BEPS.jl/stable) -->
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://CUG-hydro.github.io/BEPS.jl/dev)
[![CI](https://github.com/CUG-hydro/BEPS.jl/actions/workflows/CI.yml/badge.svg)](https://github.com/CUG-hydro/BEPS.jl/actions/workflows/CI.yml)
[![Codecov](https://codecov.io/gh/CUG-hydro/BEPS.jl/branch/master/graph/badge.svg)](https://app.codecov.io/gh/CUG-hydro/BEPS.jl/tree/master)

Boreal Ecosystem Productivity Simulator in Julia

> Dongdong Kong
BEPS.jl is alive in Julia now. All functions have been ported to Julia, and the
performance is about 2.5 times faster than C version.

>
> BEPS.jl is alive in Julia now. All functions have been ported to Julia, and the
> performance is about 2.5 times faster than C version.
>
> - Julia: 0.286327 seconds (822.38 k allocations: 22.998 MiB, 0.85% gc time)
> - C : 0.787059 seconds (629.95 k allocations: 13.915 MiB)
>
> [!CAUTION]
> `BEPS.clang` only works under Windows.
## Install

* For developers
```bash
git clone https://github.com/CUG-hydro/BEPS.jl
cd BEPS.jl/deps
git clone https://github.com/CUG-hydro/BEPS.c
```
- For developers

* For users
```bash
# In Julia
] add https://github.com/CUG-hydro/BEPS.jl
```
```bash
git clone https://github.com/CUG-hydro/BEPS.jl
cd BEPS.jl/deps
git clone https://github.com/CUG-hydro/BEPS.c
```

- For users

```bash
# In Julia
] add https://github.com/CUG-hydro/BEPS.jl
```

## Usage

Expand Down
2 changes: 1 addition & 1 deletion codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ ignore:
- "*/debug/*"
- "src/*/deprecated"
- "src/*/temp"

- "src/clang/*"

0 comments on commit 0879f5b

Please sign in to comment.