-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Jerome Justin
committed
Sep 6, 2022
1 parent
c75b116
commit 3f030aa
Showing
1 changed file
with
18 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,20 @@ | ||
# RecurrentEquilibriumNetworks.jl | ||
|
||
## Status | ||
[![Build Status](https://github.com/nic-barbara/RecurrentEquilibriumNetworks.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/nic-barbara/RecurrentEquilibriumNetworks.jl/actions/workflows/CI.yml?query=branch%3Amain) | ||
|
||
Julia package for Recurrent Equilibrium Networks. This package is a work-in-progress. For now, you may find the following links useful: | ||
## Description | ||
|
||
Julia package for Recurrent Equilibrium Networks. | ||
|
||
[NOTE] This package is a work-in-progress. For now, you may find the following links useful: | ||
- Tutorial on [developing Julia packages](https://julialang.org/contribute/developing_package/) by Chris Rackauckas (MIT) | ||
- Documentation on [managing Julia packages](https://pkgdocs.julialang.org/v1/managing-packages/) and developing unregistered packages with `Pkg.jl` | ||
|
||
So far, the package only contains a couple of test functions. To install the package for development: | ||
So far, the package only contains a couple of test functions. | ||
|
||
## How to use | ||
|
||
- Clone the repository into your Julia dev folder: | ||
- For Linux/Mac, use: `git clone [email protected]:acfr/RecurrentEquilibriumNetworks.jl.git RecurrentEquilibriumNetworks` inside your `~/.julia/dev/` directory. | ||
- Note that the repo is `RecurrentEquilibriumNetworks.jl`, but the folder is `RecurrentEquilibriumNetworks`. This is convention for Julia packages. | ||
|
@@ -15,7 +23,9 @@ So far, the package only contains a couple of test functions. To install the pac | |
- Type `using RecurrentEquilibriumNetworks` in the REPL to add the package to your current session. | ||
- Test out `test_ren_package()`. It should print `"Hello RecurrentEquilibriumNetworks.jl!"` to your screen. | ||
|
||
To contribute to the package: | ||
## To contribute to the package: | ||
|
||
|
||
- Edit source files in `src/`: | ||
- `RecurrentEquilibriumNetworks.jl` is the main file. Include dependencies and export types/functions here. | ||
- Add other source files for new functionality (eg: `src/functions.jl`). | ||
|
@@ -24,10 +34,13 @@ To contribute to the package: | |
- Run tests with `] test` | ||
- Use git to pull/push changes to the package as normal | ||
|
||
To use the package in a separate Julia workspace: | ||
## To use the package in a separate Julia workspace: | ||
|
||
|
||
- Add development version of the package with: `] dev [email protected]:acfr/RecurrentEquilibriumNetworks.jl.git` | ||
- This is instead of the usual `] add` command. We also have to use the git link not the package name because it is an unregistered Julia package. | ||
- Whenever you use the package, it will access the latest version in your `.julia/dev/` folder rather than the stable release in the `main` branch. This is easiest for development while we frequently change the package. | ||
- To use the code on the current main branch of the repo (latest stable release), instead type `] add [email protected]:acfr/RecurrentEquilibriumNetworks.jl.git`. You will have to manually update the package as normal with `] update RecurrentEquilibriumNetworks`. | ||
|
||
Email Nic Barbara ([email protected]) for any questions/concerns. | ||
### Contact | ||
Nic Barbara ([email protected]) for any questions/concerns. |