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.

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

Necessary vs. recommended dependencies #40

Closed
lostanlen opened this issue Dec 4, 2021 · 2 comments
Closed

Necessary vs. recommended dependencies #40

lostanlen opened this issue Dec 4, 2021 · 2 comments

Comments

@lostanlen
Copy link

Quoting from the review checklist of JOSS:

Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.

I have searched the word using in your package and i have found:

  • using Wavelets
  • using LinearAlgebra
  • using Statistics
  • using Plots
  • using Distributions
  • using AverageShiftedHistograms
  • using Parameters
  • using Documenter
  • using Test
  • using ImageQualityIndexes
  • using Random

It would be good to clarify which of these packages are necessary/recommended for (1) running the software (2) running the tests (3) compiling the documentation.

@zengfung
Copy link
Collaborator

zengfung commented Dec 4, 2021

Hi,

where should such clarifications be documented? We currently have 3 separate Project.toml files listing the dependencies

  • 1 in the ./ directory for running the software
  • 1 in the test/ directory for running tests
  • 1 in the docs/ directory for documentation

Is there anything we need to do further?

@lostanlen
Copy link
Author

My bad. I wasn't aware of this Project.toml mechanism. (i only knew about REQUIRE)
noted!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants