feature_update_readme about catnip

[zmaalick]

ADD: requirements, usage and licence heading.
Take a help from:
https://github.com/MetOffice/cube_helper

For usage section: we will add pypi and conda information once it is ready
for now you can add how touse within metoffice on vdi

library will be residing at:
/project/applied/SharedResources

and user just need to export path in bash file
example:
export PYTHONPATH="${PYTHONPATH}:/project/applied/SharedResources/CATNIP/lib
thats it and it will be ready to use

[zmaalick]

you can fine the associated branch to work on

[zmaalick]

I have added the library to SharedResources, you can also test that

[balazagi]

ADD: requirements, usage and licence heading.
Take a help from:
https://github.com/MetOffice/cube_helper

For usage section: we will add pypi and conda information once it is ready
for now you can add how touse within metoffice on vdi

library will be residing at:
/project/applied/SharedResources

and user just need to export path in bash file
example:
export PYTHONPATH="${PYTHONPATH}:/project/applied/SharedResources/CATNIP/lib
thats it and it will be ready to use

Do we really want to expose the path to internal directory structure? I suggest like cube_helper we keep it abstract to [path/to/catnip]
I think we are in position to add a section for License as we have one! Also the content of the Contributing section in cube_helper is generic and can be easily adapted for CATNIP so we might as well do that unless there is a reason we shouldn't?

[zmaalick]

ADD: requirements, usage and licence heading.
Take a help from:
https://github.com/MetOffice/cube_helper
For usage section: we will add pypi and conda information once it is ready
for now you can add how touse within metoffice on vdi
library will be residing at:
/project/applied/SharedResources
and user just need to export path in bash file
example:
export PYTHONPATH="${PYTHONPATH}:/project/applied/SharedResources/CATNIP/lib
thats it and it will be ready to use

Do we really want to expose the path to internal directory structure? I suggest like cube_helper we keep it abstract to [path/to/catnip]
I think we are in position to add a section for License as we have one! Also the content of the Contributing section in cube_helper is generic and can be easily adapted for CATNIP so we might as well do that unless there is a reason we shouldn't?

The main content of our library is under lib. and currently we are using it as a root path. if we use till CATNIP, then users have to do import lib.catbip, which is more weird. Cube_helper does not have lib directory. Ideally if it is a library, it should have lib or src directory.

I would suggest to add section Licence and give reference to the licence file as in cube_helper.

You can add contribution also. We will edit in future if we intend to. That would be more easy approach.

[balazagi]

ADD: requirements, usage and licence heading.
Take a help from:
https://github.com/MetOffice/cube_helper
For usage section: we will add pypi and conda information once it is ready
for now you can add how touse within metoffice on vdi
library will be residing at:
/project/applied/SharedResources
and user just need to export path in bash file
example:
export PYTHONPATH="${PYTHONPATH}:/project/applied/SharedResources/CATNIP/lib
thats it and it will be ready to use

Do we really want to expose the path to internal directory structure? I suggest like cube_helper we keep it abstract to [path/to/catnip]
I think we are in position to add a section for License as we have one! Also the content of the Contributing section in cube_helper is generic and can be easily adapted for CATNIP so we might as well do that unless there is a reason we shouldn't?

The main content of our library is under lib. and currently we are using it as a root path. if we use till CATNIP, then users have to do import lib.catbip, which is more weird. Cube_helper does not have lib directory. Ideally if it is a library, it should have lib or src directory.

I would suggest to add section Licence and give reference to the licence file as in cube_helper.

You can add contribution also. We will edit in future if we intend to. That would be more easy approach.

Ok then I will change the path to: [path/to/CATNIP/lib] and also add the License and Contribution sections