Git Product home page Git Product logo

ai4er-cookiecutter's People

Contributors

croydon-brixton avatar herbiebradley avatar sdat2 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

ai4er-cookiecutter's Issues

Fix notebook magic lines

Hey, the magic lines currently given at

notebooks/README.md are:

%load_ext autoreload             # loads the autoreload package into ipython kernel
%autoreload 2                    # sets autoreload mode to automatically reload modules when they change
%config IPCompleter.greedy=True  # enables tab completion

But they break because python seems to not allow any characters after a magic command.

https://stackoverflow.com/questions/47577596/modulenotfounderror-no-module-named-autoreload

We could move the comments to separate lines or put them above the code in the notebooks/README.md file

Add autodoc to vscode_settings.jsonc

We could add

    // Include [extendedSummary] tag in automatic docstring generation
    "autoDocstring.includeExtendedSummary": true,
    // Start each docstring on a new line
    "autoDocstring.startOnNewLine": true,
    // format docstrings using sphinx

to .setup_scripts)/vscode_settings.jsonc

Change default remote?

Hey, I was setting up a public repository on jasmin-sci3 today, but it wouldn't push to remote. It would just hang until it timed out.

The remote settings were initially:

(base) [[email protected] MLBayesInfer]$ git remote -v
origin  [email protected]:sdat2/MLBayesInfer.git (fetch)
origin  [email protected]:sdat2/MLBayesInfer.git (push)

Using:

remote set-url origin https://github.com/sdat2/MLBayesInfer.git

I changed this to:

(base) [[email protected] MLBayesInfer]$ git remote -v
origin  https://github.com/sdat2/MLBayesInfer.git (fetch)
origin  https://github.com/sdat2/MLBayesInfer.git (push)

It then it worked perfectly. Is there a reason to prefer the [email protected]: syntax? If not, it might be worth changing to https:.

Warning about inter-volume symlinks on JASMIN

The cookiecutter asks the user whether to link to a data directory. The JASMIN documentation asks users to not create inter-volume symlinks, e.g. between the home directory and the GWS. This is perhaps something the user should be warned about.

They suggest using environment variables instead. It would be handy to do this automatically; I think conda can handle environment variables.

See https://help.jasmin.ac.uk/article/176-storage#intervolsymlinks

Question on how to use the "src" directory

Hi all,

I have an embarrassingly basic question about how to use this cookiecutter repository. Let's say that one has coded up various functions in separate files and directories under src. How does one then import all the code under src as a module? I haven't tried to write my own module before, so I think I'm missing some basic ideas here. Most of the tutorials I've found online assume that one's "module" is contained in a single .py file, which obviously isn't the case here. Thanks in advance for any help/clarification that you all can provide!

Suggested command to activate environment fails

Hello,

I am trying to use the ai4er-cookiecutter to make a new repository following the command-line approach. I followed the instructions to create a conda environment:

conda env create --prefix=./env -f requirements/environment.yml

which seemed to work okay. The setup script then suggested this command:

>>> New conda env created. Activate from project directory with:
conda activate ./env

However, this command returns an error:

conda activate ./env
-bash: syntax error near unexpected token `('
-bash: syntax error near unexpected token `('

I did some quick Googling, but I didn't find a solution. FYI: I'm using bash on a MacBook, via the terminal.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.