modules/carbon/README.txt

/* $Id: README.txt,v 1.9 2008/07/02 12:53:08 johnackers Exp $ */

Carbon Drupal module

author : john ackers 


Features
-----------------------------
Allows drupal users to create and maintain personal carbon 
accounts. By entering utility meter readings, gasoline/petrol 
consumption, daily commutes and plane trips etc., users get an 
immediate indication of CO2 emissions. Measuring one's own 
footprint is a big shock and awakening for many people - it is 
not just the [insert your country] government that's at fault. 


Installation
-----------------------------

1.  Download the package into your site's '/modules' directory.
2.  Enable the 'Carbon' modules at 'Administer >> Site Building >> Modules'.
3.  Go to Administer >> Content Management >> Content Types and uncheck the  
    'promoted to front page' box on all the carbon entities.
4.  Configure permissions at 'Administer >> User Management as below.
5.  Install default sources of carbon emissions by going to 
    'Administer >> Site Configuration >> Carbon and click on 
    'install_carbon_sources'.
6.  Users can now create carbon accounts. 


Permissions
-----------------------------
Permissions are not configured during installation. For typical use, 
you should grant these permissions.

*role*                 *permissions*     
anonymous user         access accounts          
authenticated user     access accounts
                       create/edit account

Some users do need help and advice about creating their carbon
accounts. You might want to add a carbon accountant or carbon 
admin role and grant the permission 'administer carbon nodes' 
to those users providing the help.  


Configuring carbon sources 
-----------------------------
Administrators can add, adjust and remove different sources of 
carbon emissions. During installation, the carbon sources relevant 
to the UK are loaded. However these have to be amended for other 
countries. For example, much of France's electricity comes from
nuclear power and so the Kg of carbon emitted from one KilowattHour 
of energy will be lower that than in the UK. 


Shortcomings of this software
-----------------------------

1. Paging is not supported. If you ask to see all accounts
and you have access rights to see 5000, you will see them all. 

2. Sharing of accounts between users is not supported. 
However sharing between group members is. Individuals 
can currently change their group.

3. The conversion factors used to calculate KwH are not set. 
I am hoping that someone will produce a new model that includes
KwH or Joule conversion factors. 


Support
-----------------------------

Please submit issues (e.g. support requests, bug reports) to the 
drupal.org issue tracker. You will normally get a response in 
under a day. 


John Ackers   john.ackers HATT ymail.com
1	/* $Id: README.txt,v 1.9 2008/07/02 12:53:08 johnackers Exp $ */
2
3	Carbon Drupal module
4
5	author : john ackers
6
7
8	Features
9	-----------------------------
10	Allows drupal users to create and maintain personal carbon
11	accounts. By entering utility meter readings, gasoline/petrol
12	consumption, daily commutes and plane trips etc., users get an
13	immediate indication of CO2 emissions. Measuring one's own
14	footprint is a big shock and awakening for many people - it is
15	not just the [insert your country] government that's at fault.
16
17
18	Installation
19	-----------------------------
20
21	1. Download the package into your site's '/modules' directory.
22	2. Enable the 'Carbon' modules at 'Administer >> Site Building >> Modules'.
23	3. Go to Administer >> Content Management >> Content Types and uncheck the
24	'promoted to front page' box on all the carbon entities.
25	4. Configure permissions at 'Administer >> User Management as below.
26	5. Install default sources of carbon emissions by going to
27	'Administer >> Site Configuration >> Carbon and click on
28	'install_carbon_sources'.
29	6. Users can now create carbon accounts.
30
31
32	Permissions
33	-----------------------------
34	Permissions are not configured during installation. For typical use,
35	you should grant these permissions.
36
37	role permissions
38	anonymous user access accounts
39	authenticated user access accounts
40	create/edit account
41
42	Some users do need help and advice about creating their carbon
43	accounts. You might want to add a carbon accountant or carbon
44	admin role and grant the permission 'administer carbon nodes'
45	to those users providing the help.
46
47
48	Configuring carbon sources
49	-----------------------------
50	Administrators can add, adjust and remove different sources of
51	carbon emissions. During installation, the carbon sources relevant
52	to the UK are loaded. However these have to be amended for other
53	countries. For example, much of France's electricity comes from
54	nuclear power and so the Kg of carbon emitted from one KilowattHour
55	of energy will be lower that than in the UK.
56
57
58	Shortcomings of this software
59	-----------------------------
60
61	1. Paging is not supported. If you ask to see all accounts
62	and you have access rights to see 5000, you will see them all.
63
64	2. Sharing of accounts between users is not supported.
65	However sharing between group members is. Individuals
66	can currently change their group.
67
68	3. The conversion factors used to calculate KwH are not set.
69	I am hoping that someone will produce a new model that includes
70	KwH or Joule conversion factors.
71
72
73	Support
74	-----------------------------
75
76	Please submit issues (e.g. support requests, bug reports) to the
77	drupal.org issue tracker. You will normally get a response in
78	under a day.
79
80
81	John Ackers john.ackers HATT ymail.com