Curifactory assumes that it is being run inside a git repository

[deniederhut]

Is your feature request related to a problem? Please describe.
curifactory appears to call the git CLI, which results in a lot of errors if not inside a git repository

Describe the solution you'd like
It would be nice if this was added to the getting started guide

Describe alternatives you've considered
Another option would be checking for .git, then skipping whatever git-based checks curifactory is doing if not present

Additional context
Running an experiment outside git results in

fatal: not a git repository (or any of the parent directories): .git
warning: Not a git repository. Use --no-index to compare two paths outside a working tree
usage: git diff --no-index [<options>] <path> <path>

[WarmCyan]

Hmm, yeah git is a useful assumption (primarily for reproducibility, since we can store the current git commit hash alongside any experiment run info), but you're right, we should definitely call that out in the documentation.

I think we could also handle non-git-repo situations a little more gracefully and just show a single curifactory warning in the log to bug the user to use git (rather than dumping out a bunch of git errors), does that seem reasonable?

[deniederhut]

I think we could also handle non-git-repo situations a little more gracefully

I mean, I think that's up to you? If having source control is really helpful, maybe instead you want to require it and then quit if you are not in a repo?

But yes please do add it to the docs if that is the intended usage.

[WarmCyan]

I mean, I think that's up to you? If having source control is really helpful, maybe instead you want to require it and then quit if you are not in a repo?

Yeah, I personally tend to be against hardline preventing users from shooting themselves in the foot, so long as said foot-shooting is understood and intentional 😁

Since Curifactory doesn't have hard restrictions about running in other non-reproducible ways (interactive environments etc), for consistency I'll just make it spit out a warning

But yes please do add it to the docs if that is the intended usage.

Will do!